{"swagger":"2.0","info":{"version":"5.0.12.12 - 7203a853a2d6412dd75414f2d47421d7b17c0bf3-ocapi.v1.orders","title":"Connect.Ocapi.V1.Orders"},"host":"vistastats.vista.readingcinemas.com","basePath":"/WSVistaWebClient","schemes":["https"],"consumes":[],"produces":[],"paths":{"/ocapi/v1/orders/completed/{orderId}":{"get":{"tags":["Completed Orders"],"summary":"Gets the details of a {Vista.OmniChannel.Contracts.V1.Orders.CompletedOrders.ICompletedOrderBase}.","operationId":"OcapiCompletedOrders_GetCompletedOrderByOrderid","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"orderId","in":"path","description":"The unique identifier of the {Vista.OmniChannel.Contracts.V1.Orders.CompletedOrders.ICompletedOrderBase} being retrieved.","required":true,"type":"string"},{"name":"Connect-Region-Code","in":"header","description":"Region Code","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ICompletedOrderDetails&#x3C;ICompletedOrderBase&#8203;&#8203;&#x3E;&#8203;&#8203;"}},"404":{"description":"Order does not exist."}},"contractResolver":{"DynamicCodeGeneration":true,"DefaultMembersSearchFlags":20,"SerializeCompilerGeneratedMembers":false,"IgnoreSerializableInterface":false,"IgnoreSerializableAttribute":true,"IgnoreIsSpecifiedMembers":false,"IgnoreShouldSerializeMembers":false,"NamingStrategy":{"ProcessDictionaryKeys":true,"ProcessExtensionDataNames":false,"OverrideSpecifiedNames":true}}}},"/ocapi/v1/orders/completed/{orderId}/collection-status/collected":{"put":{"tags":["Completed Orders"],"summary":"Sets the {Vista.OmniChannel.Contracts.V1.Orders.Lines.OrderLineCollectionStatus} of all lines in a {Vista.OmniChannel.Contracts.V1.Orders.CompletedOrders.ICompletedOrderBase} to {Vista.OmniChannel.Contracts.V1.Orders.Lines.OrderLineCollectionStatus.Collected}.","description":"<para>\r\n            Calling this endpoint confirms that all {Vista.OmniChannel.Contracts.V1.Orders.CompletedOrders.ICompletedOrderPrintStreams} have been printed and will prevent any further calls to {M:WSVistaWebClient.Ocapi.V1.Orders.CompletedOrders.OcapiCompletedOrdersController.GetPrintStreams(System.String,System.String,System.String)}.\r\n            </para>\r\n<para>\r\n            This endpoint will also start the preparation of any items in a {Vista.OmniChannel.Contracts.V1.Orders.CompletedOrders.ICompletedStandardOrder}, so a further call to {M:WSVistaWebClient.Ocapi.V1.Orders.CompletedOrders.OcapiCompletedOrdersController.StartOrderPreparation(System.String)} is not necessary.\r\n            The {Vista.OmniChannel.Contracts.V1.Orders.CompletedOrders.ICompletedOrderPrintStreams.ItemCollectionVouchers} will contain relevant collection details.\r\n            </para>\r\n<para>\r\n            Response Error Codes:\r\n            * 400 - 16200 - The requested order is already collected.\r\n            </para>","operationId":"OcapiCompletedOrders_SetOrderAsCollectedByOrderid","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"orderId","in":"path","description":"The unique identifier of the {Vista.OmniChannel.Contracts.V1.Orders.CompletedOrders.ICompletedOrderBase} being retrieved.","required":true,"type":"string"},{"name":"Connect-Region-Code","in":"header","description":"Region Code","required":false,"type":"string"}],"responses":{"204":{"description":"Order collection status updated."},"400":{"description":"Order has already been collected."},"404":{"description":"Order does not exist."}},"contractResolver":{"DynamicCodeGeneration":true,"DefaultMembersSearchFlags":20,"SerializeCompilerGeneratedMembers":false,"IgnoreSerializableInterface":false,"IgnoreSerializableAttribute":true,"IgnoreIsSpecifiedMembers":false,"IgnoreShouldSerializeMembers":false,"NamingStrategy":{"ProcessDictionaryKeys":true,"ProcessExtensionDataNames":false,"OverrideSpecifiedNames":true}}}},"/ocapi/v1/orders/completed/{orderId}/preparation":{"post":{"tags":["Completed Orders"],"summary":"Starts preparation of items in a {Vista.OmniChannel.Contracts.V1.Orders.CompletedOrders.ICompletedStandardOrder}.","description":"<para>\r\n            Calling this endpoint will also set the CollectionStatus of the items to Collected.\r\n            </para>\r\n<para>\r\n            It is not necessary to call this endpoint if {M:WSVistaWebClient.Ocapi.V1.Orders.CompletedOrders.OcapiCompletedOrdersController.SetOrderAsCollected(System.String)} had been called prior\r\n            as the concession items that require preparing will have already been sent to the kitchen.\r\n            </para>\r\n<para>\r\n            Response Error Codes:\r\n            * 400 - 16100 - Order does not have items requiring preparation.\r\n            * 400 - 16101 - Order preparation has already been started.\r\n            </para>","operationId":"OcapiCompletedOrders_StartOrderPreparationByOrderid","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"orderId","in":"path","description":"The unique identifier of the {Vista.OmniChannel.Contracts.V1.Orders.CompletedOrders.ICompletedStandardOrder} that is to be prepared for collection.","required":true,"type":"string"},{"name":"Connect-Region-Code","in":"header","description":"Region Code","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/IOrderPreparation&#8203;&#8203;"}},"400":{"description":"Order preparation cannot be started."},"404":{"description":"Order does not exist."}},"contractResolver":{"DynamicCodeGeneration":true,"DefaultMembersSearchFlags":20,"SerializeCompilerGeneratedMembers":false,"IgnoreSerializableInterface":false,"IgnoreSerializableAttribute":true,"IgnoreIsSpecifiedMembers":false,"IgnoreShouldSerializeMembers":false,"NamingStrategy":{"ProcessDictionaryKeys":true,"ProcessExtensionDataNames":false,"OverrideSpecifiedNames":true}}}},"/ocapi/v1/orders/completed/{orderId}/print-streams":{"get":{"tags":["Completed Orders"],"summary":"Gets the print streams of an uncollected {Vista.OmniChannel.Contracts.V1.Orders.CompletedOrders.ICompletedOrderBase} that are compatible with the requested printer.","description":"<para>\r\n            Response Error Codes:\r\n            * 400 - 16200 - The requested order is already collected.\r\n            * 400 - 16201 - The requested order is currently being printed.\r\n            </para>\r\n#### Errors\r\n\r\n - HTTP Status **400**: Error Code **16200**: The requested order is already collected.\r\n - HTTP Status **400**: Error Code **16201**: The requested order is currently being printed.\r\n\r\n","operationId":"OcapiCompletedOrders_GetPrintStreamsByOrderid","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"orderId","in":"path","description":"The unique identifier of the {Vista.OmniChannel.Contracts.V1.Orders.CompletedOrders.ICompletedOrderBase} being retrieved.","required":true,"type":"string"},{"name":"printTemplateName","in":"query","description":"The name of the print templates to generate the print streams with.","required":true,"type":"string"},{"name":"languageTag","in":"query","description":"The IETF (RFC 4646) language tag representing the desired language that the print streams will be generated in.\r\nIf not supplied, the default language configured at cinema will be used.","required":false,"type":"string"},{"name":"Connect-Region-Code","in":"header","description":"Region Code","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ICompletedOrderPrintStreams&#8203;&#8203;"}},"400":{"description":"Invalid query parameter, or the order is in an invalid state."},"404":{"description":"Order does not exist."}},"contractResolver":{"DynamicCodeGeneration":true,"DefaultMembersSearchFlags":20,"SerializeCompilerGeneratedMembers":false,"IgnoreSerializableInterface":false,"IgnoreSerializableAttribute":true,"IgnoreIsSpecifiedMembers":false,"IgnoreShouldSerializeMembers":false,"NamingStrategy":{"ProcessDictionaryKeys":true,"ProcessExtensionDataNames":false,"OverrideSpecifiedNames":true}}}},"/ocapi/v1/orders/completed/{orderId}/showtimes/{showtimeId}/seats":{"put":{"tags":["Completed Orders"],"summary":"Swaps the seats for an {Vista.OmniChannel.Contracts.V1.Orders.Showtimes.IOrderShowtime} within a {Vista.OmniChannel.Contracts.V1.Orders.CompletedOrders.ICompletedStandardOrder}.","description":"<para>This endpoint can only be used for completed orders. To change the seats in a {Vista.OmniChannel.Contracts.V1.Orders.InProgressOrders.IInProgressStandardOrder}, use {M:WSVistaWebClient.Ocapi.V1.Orders.InProgressOrders.Showtimes.OcapiOrderShowtimesController.SetShowtime(System.String,System.String,Vista.Connect.WebApi.Contracts.Ocapi.V1.Orders.Showtimes.Requests.OrderShowtimeRequest)} instead.</para>\r\n<para>Seats can only be swapped when {Vista.OmniChannel.Contracts.V1.Orders.Showtimes.IOrderShowtimeSeatSwapStatus.IsAvailable} equals <see langword=\"true\" />.</para>\r\n#### Errors\r\n\r\n - HTTP Status **400**: Error Code **16000**: Swap seats is not enabled.\r\n - HTTP Status **400**: Error Code **16001**: The requested showtime does not have allocated seating.\r\n - HTTP Status **400**: Error Code **16002**: The requested order has no seats.\r\n - HTTP Status **400**: Error Code **16003**: The requested order contains package tickets.\r\n - HTTP Status **400**: Error Code **16004**: The requested order includes in seat delivery.\r\n - HTTP Status **400**: Error Code **16005**: The requested order has been refunded.\r\n - HTTP Status **400**: Error Code **16006**: One of the requested seats does not exist.\r\n - HTTP Status **400**: Error Code **16007**: One of the requested seats is in an invalid area category.\r\n - HTTP Status **400**: Error Code **16008**: One or more requested seats are unavailable.\r\n - HTTP Status **400**: Error Code **16009**: The requested seats contain duplicates.\r\n - HTTP Status **400**: Error Code **16010**: The requested session has finished.\r\n - HTTP Status **400**: Error Code **16011**: The requested order booking mode is unpaid.\r\n\r\n","operationId":"OcapiCompletedOrders_SwapSeatsByOrderidAndShowtimeid","consumes":["application/json","text/json","application/x-www-form-urlencoded"],"produces":["application/json","text/json"],"parameters":[{"name":"orderId","in":"path","description":"The unique identifier of the {Vista.OmniChannel.Contracts.V1.Orders.CompletedOrders.ICompletedStandardOrder} being modified.","required":true,"type":"string"},{"name":"showtimeId","in":"path","description":"The unique identifier of the {Vista.OmniChannel.Contracts.V1.Orders.Showtimes.IOrderShowtime} being modified.","required":true,"type":"string"},{"name":"request","in":"body","description":"The requested replacement seats.","required":true,"schema":{"$ref":"#/definitions/OrderShowtimeSeatSwapRequest&#8203;&#8203;"}},{"name":"Connect-Region-Code","in":"header","description":"Region Code","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ICompletedOrderDetails&#x3C;ICompletedStandardOrder&#8203;&#8203;&#x3E;&#8203;&#8203;"}},"400":{"description":"Request property is invalid or missing, or seats cannot be swapped."},"404":{"description":"Order or showtime does not exist."}},"contractResolver":{"DynamicCodeGeneration":true,"DefaultMembersSearchFlags":20,"SerializeCompilerGeneratedMembers":false,"IgnoreSerializableInterface":false,"IgnoreSerializableAttribute":true,"IgnoreIsSpecifiedMembers":false,"IgnoreShouldSerializeMembers":false,"NamingStrategy":{"ProcessDictionaryKeys":true,"ProcessExtensionDataNames":false,"OverrideSpecifiedNames":true}}}},"/ocapi/v1/orders/completed/by-journey-reference/{journeyReference}/identifiers":{"get":{"tags":["Completed Orders"],"summary":"Gets the {Vista.OmniChannel.Contracts.V1.Orders.CompletedOrders.ICompletedStandardOrderIdentifiers} for a {Vista.OmniChannel.Contracts.V1.Orders.CompletedOrders.ICompletedStandardOrder} via the {Vista.OmniChannel.Contracts.V1.Orders.CompletedOrders.ICompletedStandardOrder.JourneyReference}.","description":"<para>\r\n            Gets a set of identifiers that can be used to call other OCAPI endpoints in a consistent manner.\r\n            </para>","operationId":"OcapiCompletedOrders_GetOrderIdentifiersByJourneyReference","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"journeyReference","in":"path","description":"External identifier of {Vista.OmniChannel.Contracts.V1.Orders.CompletedOrders.ICompletedStandardOrder}.","required":true,"type":"string"},{"name":"Connect-Region-Code","in":"header","description":"Region Code","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ICompletedStandardOrderIdentifiers&#8203;&#8203;"}},"404":{"description":"Order does not exist."}},"contractResolver":{"DynamicCodeGeneration":true,"DefaultMembersSearchFlags":20,"SerializeCompilerGeneratedMembers":false,"IgnoreSerializableInterface":false,"IgnoreSerializableAttribute":true,"IgnoreIsSpecifiedMembers":false,"IgnoreShouldSerializeMembers":false,"NamingStrategy":{"ProcessDictionaryKeys":true,"ProcessExtensionDataNames":false,"OverrideSpecifiedNames":true}}}},"/ocapi/v1/orders/{orderId}/completion":{"get":{"tags":["Completion"],"summary":"Gets the {Vista.OmniChannel.Contracts.V1.Orders.Completions.IOrderCompletion} for an {Vista.OmniChannel.Contracts.V1.Orders.InProgressOrders.IInProgressOrderBase}.","description":"<para>This endpoint may be polled to determine when the order completion has been finished.</para>\r\n#### Errors\r\n\r\n - HTTP Status **400**: Error Code **14000**: Create member request is invalid.\r\n - HTTP Status **400**: Error Code **14001**: Failed to create a member.\r\n\r\n","operationId":"OcapiOrderCompletion_GetOrderCompletionByOrderid","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"orderId","in":"path","description":"The unique identifier of the {Vista.OmniChannel.Contracts.V1.Orders.InProgressOrders.IInProgressOrderBase}.","required":true,"type":"string"},{"name":"Connect-Region-Code","in":"header","description":"Region Code","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/IOrderCompletion&#8203;&#8203;"}},"404":{"description":"Order does not exist, or completion has not been created."}},"contractResolver":{"DynamicCodeGeneration":true,"DefaultMembersSearchFlags":20,"SerializeCompilerGeneratedMembers":false,"IgnoreSerializableInterface":false,"IgnoreSerializableAttribute":true,"IgnoreIsSpecifiedMembers":false,"IgnoreShouldSerializeMembers":false,"NamingStrategy":{"ProcessDictionaryKeys":true,"ProcessExtensionDataNames":false,"OverrideSpecifiedNames":true}}},"post":{"tags":["Completion"],"summary":"Creates an {Vista.OmniChannel.Contracts.V1.Orders.Completions.IOrderCompletion} for an {Vista.OmniChannel.Contracts.V1.Orders.InProgressOrders.IInProgressOrderBase}.","description":"<para>\r\n            An {Vista.OmniChannel.Contracts.V1.Orders.Completions.IOrderCompletion} is automatically created upon completion of a successful {Vista.OmniChannel.Contracts.V1.Orders.Payments.Embedded.IOrderEmbeddedPayment}\r\n            but must be manually created for zero value orders, unpaid orders or orders paid entirely by {Vista.OmniChannel.Contracts.V1.Orders.Payments.GiftCards.IOrderGiftCardPayment} payments.\r\n            </para>","operationId":"OcapiOrderCompletion_CreateOrderCompletionByOrderid","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"orderId","in":"path","description":"The unique identifier of the {Vista.OmniChannel.Contracts.V1.Orders.InProgressOrders.IInProgressOrderBase} being completed.","required":true,"type":"string"},{"name":"Connect-Region-Code","in":"header","description":"Region Code","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/IOrderCompletion&#8203;&#8203;"}},"400":{"description":"Order cannot be completed."},"404":{"description":"Order does not exist."}},"contractResolver":{"DynamicCodeGeneration":true,"DefaultMembersSearchFlags":20,"SerializeCompilerGeneratedMembers":false,"IgnoreSerializableInterface":false,"IgnoreSerializableAttribute":true,"IgnoreIsSpecifiedMembers":false,"IgnoreShouldSerializeMembers":false,"NamingStrategy":{"ProcessDictionaryKeys":true,"ProcessExtensionDataNames":false,"OverrideSpecifiedNames":true}}}},"/ocapi/v1/orders/{orderId}/payments/gift-cards":{"post":{"tags":["Gift Cards"],"summary":"Adds a gift card payment to the order.","description":"Payment details are stored against order and processed when order is complete.\r\n#### Errors\r\n\r\n - HTTP Status **400**: Error Code **11000**: Invalid payment amount requested\r\n - HTTP Status **400**: Error Code **11001**: No remaining balance to pay\r\n - HTTP Status **400**: Error Code **11050**: Invalid gift card card number or pin\r\n - HTTP Status **400**: Error Code **11051**: Gift card expired\r\n - HTTP Status **400**: Error Code **11052**: Insufficient gift card balance\r\n - HTTP Status **400**: Error Code **11053**: Gift card already added\r\n\r\n","operationId":"OcapiOrderPayments_AddGiftCardPaymentByOrderid","consumes":["application/json","text/json","application/x-www-form-urlencoded"],"produces":["application/json","text/json"],"parameters":[{"name":"orderId","in":"path","description":"The unique identifier of the {Vista.OmniChannel.Contracts.V1.Orders.InProgressOrders.IInProgressOrderBase} that the payment will be added to.","required":true,"type":"string"},{"name":"giftCardPayment","in":"body","description":"The gift card payment request.","required":true,"schema":{"$ref":"#/definitions/OrderGiftCardPaymentCreate&#8203;&#8203;"}},{"name":"Connect-Region-Code","in":"header","description":"Region Code","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/IOrderGiftCardPayment&#8203;&#8203;"}},"400":{"description":"Request property is invalid or missing, or gift card cannot be added."},"404":{"description":"Order does not exist."},"429":{"description":"Too many requests. Try again later.","schema":{"$ref":"#/definitions/RateLimitExceededError&#8203;&#8203;"}}},"contractResolver":{"DynamicCodeGeneration":true,"DefaultMembersSearchFlags":20,"SerializeCompilerGeneratedMembers":false,"IgnoreSerializableInterface":false,"IgnoreSerializableAttribute":true,"IgnoreIsSpecifiedMembers":false,"IgnoreShouldSerializeMembers":false,"NamingStrategy":{"ProcessDictionaryKeys":true,"ProcessExtensionDataNames":false,"OverrideSpecifiedNames":true}}}},"/ocapi/v1/orders/gift-shop":{"post":{"tags":["Gift shop"],"summary":"Creates an {Vista.OmniChannel.Contracts.V1.Orders.InProgressOrders.IInProgressGiftShopOrder}.","operationId":"OcapiOrders_CreateGiftShopOrder","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"Connect-Region-Code","in":"header","description":"Region Code","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/IInProgressOrderDetails&#x3C;IInProgressGiftShopOrder&#8203;&#8203;&#x3E;&#8203;&#8203;"}},"400":{"description":"Gift shop does not exist."}},"contractResolver":{"DynamicCodeGeneration":true,"DefaultMembersSearchFlags":20,"SerializeCompilerGeneratedMembers":false,"IgnoreSerializableInterface":false,"IgnoreSerializableAttribute":true,"IgnoreIsSpecifiedMembers":false,"IgnoreShouldSerializeMembers":false,"NamingStrategy":{"ProcessDictionaryKeys":true,"ProcessExtensionDataNames":false,"OverrideSpecifiedNames":true}}}},"/ocapi/v1/orders/{orderId}/items":{"put":{"tags":["Items"],"summary":"Sets the items for an {Vista.OmniChannel.Contracts.V1.Orders.InProgressOrders.IInProgressStandardOrder} or {Vista.OmniChannel.Contracts.V1.Orders.InProgressOrders.IInProgressGiftShopOrder}.","description":"<para>Existing items on the order will be replaced with the specified selections.</para>\r\n<para>Note: Items with attached scarcity such as items with *selling limits* currently may fail on repeated PUT as this API is currently not fully atomic.</para>","operationId":"OcapiOrderItems_SetItemsByOrderid","consumes":["application/json","text/json","application/x-www-form-urlencoded"],"produces":["application/json","text/json"],"parameters":[{"name":"orderId","in":"path","description":"The unique identifier of the {Vista.OmniChannel.Contracts.V1.Orders.InProgressOrders.IInProgressStandardOrder} or {Vista.OmniChannel.Contracts.V1.Orders.InProgressOrders.IInProgressGiftShopOrder} being modified.","required":true,"type":"string"},{"name":"selections","in":"body","description":"The requested items.","required":true,"schema":{"$ref":"#/definitions/OrderItemsRequest&#8203;&#8203;"}},{"name":"Connect-Region-Code","in":"header","description":"Region Code","required":false,"type":"string"}],"responses":{"200":{"description":"Order items","schema":{"$ref":"#/definitions/IInProgressOrderDetails&#x3C;IInProgressOrderBase&#8203;&#8203;&#x3E;&#8203;&#8203;"}},"400":{"description":"Request property is invalid or missing, or invalid order type."},"404":{"description":"Order does not exist."}},"contractResolver":{"DynamicCodeGeneration":true,"DefaultMembersSearchFlags":20,"SerializeCompilerGeneratedMembers":false,"IgnoreSerializableInterface":false,"IgnoreSerializableAttribute":true,"IgnoreIsSpecifiedMembers":false,"IgnoreShouldSerializeMembers":false,"NamingStrategy":{"ProcessDictionaryKeys":true,"ProcessExtensionDataNames":false,"OverrideSpecifiedNames":true}}}},"/ocapi/v1/orders/{orderId}/payments/maximum-member-balance":{"get":{"tags":["Members"],"summary":"Gets the {Vista.OmniChannel.Contracts.V1.Orders.Payments.MemberBalance.Maximum.IOrderMaximumMemberBalancePayment} for an {Vista.OmniChannel.Contracts.V1.Orders.InProgressOrders.IInProgressOrderBase}.","description":"<para>The currently authenticated {Vista.OmniChannel.Contracts.V1.Loyalty.Members.IMember} must have a {Vista.OmniChannel.Contracts.V1.Loyalty.Members.Cards.IMemberCard} and a supported {Vista.OmniChannel.Contracts.V1.Loyalty.MasterData.BalanceTypes.IBalanceType} in order to make a {Vista.OmniChannel.Contracts.V1.Loyalty.Members.Balances.IMemberBalance} payment.</para>","operationId":"OcapiOrderPayments_GetMaximumMemberBalancePaymentByOrderid","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"orderId","in":"path","description":"The unique identifier of the {Vista.OmniChannel.Contracts.V1.Orders.InProgressOrders.IInProgressOrderBase} that the payment is for.","required":true,"type":"string"},{"name":"loyaltySessionToken","in":"header","description":"Current Loyalty session token, represents a 'signed-in' member","required":false,"type":"string"},{"name":"Connect-Region-Code","in":"header","description":"Region Code","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/IOrderMaximumMemberBalancePaymentDetails&#8203;&#8203;"}},"204":{"description":"Member has no card, or does not have a supported balance type."},"401":{"description":"No member signed in."},"404":{"description":"Order does not exist."}},"contractResolver":{"DynamicCodeGeneration":true,"DefaultMembersSearchFlags":20,"SerializeCompilerGeneratedMembers":false,"IgnoreSerializableInterface":false,"IgnoreSerializableAttribute":true,"IgnoreIsSpecifiedMembers":false,"IgnoreShouldSerializeMembers":false,"NamingStrategy":{"ProcessDictionaryKeys":true,"ProcessExtensionDataNames":false,"OverrideSpecifiedNames":true}}}},"/ocapi/v1/orders/{orderId}/payments/member-balance":{"put":{"tags":["Members"],"summary":"Sets the {Vista.OmniChannel.Contracts.V1.Orders.Payments.MemberBalance.IOrderMemberBalancePayment} for an {Vista.OmniChannel.Contracts.V1.Orders.InProgressOrders.IInProgressOrderBase}.","description":"<para>The currently authenticated {Vista.OmniChannel.Contracts.V1.Loyalty.Members.IMember} must have a {Vista.OmniChannel.Contracts.V1.Loyalty.Members.Cards.IMemberCard} and a supported {Vista.OmniChannel.Contracts.V1.Loyalty.MasterData.BalanceTypes.IBalanceType} in order to make a {Vista.OmniChannel.Contracts.V1.Loyalty.Members.Balances.IMemberBalance} payment.</para>","operationId":"OcapiOrderPayments_SetMemberBalancePaymentByOrderid","consumes":["application/json","text/json","application/x-www-form-urlencoded"],"produces":["application/json","text/json"],"parameters":[{"name":"orderId","in":"path","description":"The unique identifier of the {Vista.OmniChannel.Contracts.V1.Orders.InProgressOrders.IInProgressOrderBase} that the payment is for.","required":true,"type":"string"},{"name":"request","in":"body","description":"The member balance payment request.","required":true,"schema":{"$ref":"#/definitions/OrderMemberBalancePaymentUpdate&#8203;&#8203;"}},{"name":"loyaltySessionToken","in":"header","description":"Current Loyalty session token, represents a 'signed-in' member","required":false,"type":"string"},{"name":"Connect-Region-Code","in":"header","description":"Region Code","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/IOrderMemberBalancePayment&#8203;&#8203;"}},"400":{"description":"Member has no card, or a non-positive value was specified."},"401":{"description":"No member signed in."}},"contractResolver":{"DynamicCodeGeneration":true,"DefaultMembersSearchFlags":20,"SerializeCompilerGeneratedMembers":false,"IgnoreSerializableInterface":false,"IgnoreSerializableAttribute":true,"IgnoreIsSpecifiedMembers":false,"IgnoreShouldSerializeMembers":false,"NamingStrategy":{"ProcessDictionaryKeys":true,"ProcessExtensionDataNames":false,"OverrideSpecifiedNames":true}}}},"/ocapi/v1/orders/{orderId}":{"get":{"tags":["Orders"],"summary":"Gets the details of a {Vista.OmniChannel.Contracts.V1.Orders.InProgressOrders.IInProgressOrderBase}.","operationId":"OcapiOrders_GetOrderByOrderid","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"orderId","in":"path","description":"The unique identifier of the {Vista.OmniChannel.Contracts.V1.Orders.InProgressOrders.IInProgressOrderBase} being retrieved.","required":true,"type":"string"},{"name":"Connect-Region-Code","in":"header","description":"Region Code","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/IInProgressOrderDetails&#x3C;IInProgressOrderBase&#8203;&#8203;&#x3E;&#8203;&#8203;"}},"404":{"description":"Order does not exist."}},"contractResolver":{"DynamicCodeGeneration":true,"DefaultMembersSearchFlags":20,"SerializeCompilerGeneratedMembers":false,"IgnoreSerializableInterface":false,"IgnoreSerializableAttribute":true,"IgnoreIsSpecifiedMembers":false,"IgnoreShouldSerializeMembers":false,"NamingStrategy":{"ProcessDictionaryKeys":true,"ProcessExtensionDataNames":false,"OverrideSpecifiedNames":true}}},"delete":{"tags":["Orders"],"summary":"Cancels an {Vista.OmniChannel.Contracts.V1.Orders.InProgressOrders.IInProgressOrderBase}.","operationId":"OcapiOrders_CancelOrderByOrderid","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"orderId","in":"path","description":"The unique identifier of the {Vista.OmniChannel.Contracts.V1.Orders.InProgressOrders.IInProgressOrderBase} being cancelled.","required":true,"type":"string"},{"name":"Connect-Region-Code","in":"header","description":"Region Code","required":false,"type":"string"}],"responses":{"204":{"description":"Order cancelled."}},"contractResolver":{"DynamicCodeGeneration":true,"DefaultMembersSearchFlags":20,"SerializeCompilerGeneratedMembers":false,"IgnoreSerializableInterface":false,"IgnoreSerializableAttribute":true,"IgnoreIsSpecifiedMembers":false,"IgnoreShouldSerializeMembers":false,"NamingStrategy":{"ProcessDictionaryKeys":true,"ProcessExtensionDataNames":false,"OverrideSpecifiedNames":true}}}},"/ocapi/v1/orders/{orderId}/customer":{"get":{"tags":["Orders"],"summary":"Gets the customer set on an {Vista.OmniChannel.Contracts.V1.Orders.InProgressOrders.IInProgressOrderBase}.","operationId":"OcapiOrderCustomer_GetCustomerByOrderid","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"orderId","in":"path","description":"The unique identifier of the {Vista.OmniChannel.Contracts.V1.Orders.InProgressOrders.IInProgressOrderBase}.","required":true,"type":"string"},{"name":"Connect-Region-Code","in":"header","description":"Region Code","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/IOrderCustomer&#8203;&#8203;"}},"404":{"description":"Order does not exist, or customer has not been set."}},"contractResolver":{"DynamicCodeGeneration":true,"DefaultMembersSearchFlags":20,"SerializeCompilerGeneratedMembers":false,"IgnoreSerializableInterface":false,"IgnoreSerializableAttribute":true,"IgnoreIsSpecifiedMembers":false,"IgnoreShouldSerializeMembers":false,"NamingStrategy":{"ProcessDictionaryKeys":true,"ProcessExtensionDataNames":false,"OverrideSpecifiedNames":true}}},"put":{"tags":["Orders"],"summary":"Sets the customer for an {Vista.OmniChannel.Contracts.V1.Orders.InProgressOrders.IInProgressStandardOrder} or {Vista.OmniChannel.Contracts.V1.Orders.InProgressOrders.IInProgressGiftShopOrder}.","description":"<para>\r\n            This endpoint is not available for {Vista.OmniChannel.Contracts.V1.Orders.InProgressOrders.IInProgressSubscriptionOrder} entities, as the {Vista.OmniChannel.Contracts.V1.Orders.Customers.IOrderCustomer} is\r\n            automatically set based on the details of the authenticated {Vista.OmniChannel.Contracts.V1.Loyalty.Members.IMember}.\r\n            </para>","operationId":"OcapiOrderCustomer_SetCustomerByOrderid","consumes":["application/json","text/json","application/x-www-form-urlencoded"],"produces":["application/json","text/json"],"parameters":[{"name":"orderId","in":"path","description":"The unique identifier of the {Vista.OmniChannel.Contracts.V1.Orders.InProgressOrders.IInProgressStandardOrder} or {Vista.OmniChannel.Contracts.V1.Orders.InProgressOrders.IInProgressGiftShopOrder} being modified.","required":true,"type":"string"},{"name":"customer","in":"body","description":"The customer's details.","required":true,"schema":{"$ref":"#/definitions/OrderCustomer&#8203;&#8203;"}},{"name":"Connect-Region-Code","in":"header","description":"Region Code","required":false,"type":"string"}],"responses":{"204":{"description":"Order customer updated."},"400":{"description":"Request property is invalid or missing, or customer cannot be set."},"404":{"description":"Order does not exist."}},"contractResolver":{"DynamicCodeGeneration":true,"DefaultMembersSearchFlags":20,"SerializeCompilerGeneratedMembers":false,"IgnoreSerializableInterface":false,"IgnoreSerializableAttribute":true,"IgnoreIsSpecifiedMembers":false,"IgnoreShouldSerializeMembers":false,"NamingStrategy":{"ProcessDictionaryKeys":true,"ProcessExtensionDataNames":false,"OverrideSpecifiedNames":true}}}},"/ocapi/v1/orders/{orderId}/expiry/reset":{"post":{"tags":["Orders"],"summary":"Resets the expiry of an {Vista.OmniChannel.Contracts.V1.Orders.InProgressOrders.IInProgressOrderBase}.","operationId":"OcapiOrders_ResetOrderExpiryByOrderid","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"orderId","in":"path","description":"The unique identifier of the {Vista.OmniChannel.Contracts.V1.Orders.InProgressOrders.IInProgressOrderBase} being reset.","required":true,"type":"string"},{"name":"Connect-Region-Code","in":"header","description":"Region Code","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/IInProgressOrderDetails&#x3C;IInProgressOrderBase&#8203;&#8203;&#x3E;&#8203;&#8203;"}},"404":{"description":"Order does not exist."}},"contractResolver":{"DynamicCodeGeneration":true,"DefaultMembersSearchFlags":20,"SerializeCompilerGeneratedMembers":false,"IgnoreSerializableInterface":false,"IgnoreSerializableAttribute":true,"IgnoreIsSpecifiedMembers":false,"IgnoreShouldSerializeMembers":false,"NamingStrategy":{"ProcessDictionaryKeys":true,"ProcessExtensionDataNames":false,"OverrideSpecifiedNames":true}}}},"/ocapi/v1/orders/{orderId}/payments/{paymentId}":{"delete":{"tags":["Orders","Payments"],"summary":"Removes an {Vista.OmniChannel.Contracts.V1.Orders.Payments.IOrderPaymentBase} from an {Vista.OmniChannel.Contracts.V1.Orders.InProgressOrders.IInProgressOrderBase}.","description":"<para>\r\n            Only {Vista.OmniChannel.Contracts.V1.Orders.Payments.GiftCards.IOrderGiftCardPayment} and {Vista.OmniChannel.Contracts.V1.Orders.Payments.MemberBalance.IOrderMemberBalancePayment} entities can be removed at this time.\r\n            </para>","operationId":"OcapiOrderPayments_RemovePaymentByOrderidAndPaymentid","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"orderId","in":"path","description":"The unique identifier of the {Vista.OmniChannel.Contracts.V1.Orders.InProgressOrders.IInProgressOrderBase} that the payment will be removed from.","required":true,"type":"string"},{"name":"paymentId","in":"path","description":"The unique identifier of the {Vista.OmniChannel.Contracts.V1.Orders.Payments.IOrderPaymentBase} to be removed.","required":true,"type":"string"},{"name":"Connect-Region-Code","in":"header","description":"Region Code","required":false,"type":"string"}],"responses":{"204":{"description":"Payment removed."},"400":{"description":"Payment cannot be removed."}},"contractResolver":{"DynamicCodeGeneration":true,"DefaultMembersSearchFlags":20,"SerializeCompilerGeneratedMembers":false,"IgnoreSerializableInterface":false,"IgnoreSerializableAttribute":true,"IgnoreIsSpecifiedMembers":false,"IgnoreShouldSerializeMembers":false,"NamingStrategy":{"ProcessDictionaryKeys":true,"ProcessExtensionDataNames":false,"OverrideSpecifiedNames":true}}}},"/ocapi/v1/orders/standard/booking":{"post":{"tags":["Orders"],"summary":"Creates an {Vista.OmniChannel.Contracts.V1.Orders.InProgressOrders.IInProgressStandardOrder} as a booking.","description":"\r\n#### Errors\r\n\r\n - HTTP Status **400**: Error Code **17000**: Invalid site identifier.\r\n\r\n","operationId":"OcapiOrders_CreateStandardOrderAsBooking","consumes":["application/json","text/json","application/x-www-form-urlencoded"],"produces":["application/json","text/json"],"parameters":[{"name":"standardOrderAsBookingCreate","in":"body","description":"Details of the order to be created.","required":true,"schema":{"$ref":"#/definitions/StandardOrderAsBookingCreate&#8203;&#8203;"}},{"name":"Connect-Region-Code","in":"header","description":"Region Code","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/IInProgressOrderDetails&#x3C;IInProgressStandardOrder&#8203;&#8203;&#x3E;&#8203;&#8203;"}},"400":{"description":"Site does not exist."}},"contractResolver":{"DynamicCodeGeneration":true,"DefaultMembersSearchFlags":20,"SerializeCompilerGeneratedMembers":false,"IgnoreSerializableInterface":false,"IgnoreSerializableAttribute":true,"IgnoreIsSpecifiedMembers":false,"IgnoreShouldSerializeMembers":false,"NamingStrategy":{"ProcessDictionaryKeys":true,"ProcessExtensionDataNames":false,"OverrideSpecifiedNames":true}}}},"/ocapi/v1/orders/{orderId}/payments/embedded":{"post":{"tags":["Payments"],"summary":"Creates a {Vista.OmniChannel.Contracts.V1.Orders.Payments.Embedded.IOrderEmbeddedPayment}.","description":"<para>Initiates an {Vista.OmniChannel.Contracts.V1.Orders.Payments.Embedded.IOrderEmbeddedPayment} with the connector so that the client can render a UI based on the returned {Vista.OmniChannel.Contracts.V1.Orders.Payments.Embedded.IOrderEmbeddedPaymentClientData}.</para>","operationId":"OcapiOrderPayments_CreateEmbeddedPaymentByOrderid","consumes":["application/json","text/json","application/x-www-form-urlencoded"],"produces":["application/json","text/json"],"parameters":[{"name":"orderId","in":"path","description":"The unique identifier of the current {Vista.OmniChannel.Contracts.V1.Orders.InProgressOrders.IInProgressOrderBase} for which the payment is starting.","required":true,"type":"string"},{"name":"paymentParameters","in":"body","description":"Values needed to start the embedded payment.","required":true,"schema":{"$ref":"#/definitions/OrderEmbeddedPaymentCreate&#8203;&#8203;"}},{"name":"Connect-Region-Code","in":"header","description":"Region Code","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ICreatedOrderEmbeddedPayment&#8203;&#8203;"}},"400":{"description":"Request property is invalid or missing, or payment method does not exist."},"404":{"description":"Order does not exist."}},"contractResolver":{"DynamicCodeGeneration":true,"DefaultMembersSearchFlags":20,"SerializeCompilerGeneratedMembers":false,"IgnoreSerializableInterface":false,"IgnoreSerializableAttribute":true,"IgnoreIsSpecifiedMembers":false,"IgnoreShouldSerializeMembers":false,"NamingStrategy":{"ProcessDictionaryKeys":true,"ProcessExtensionDataNames":false,"OverrideSpecifiedNames":true}}}},"/ocapi/v1/orders/{orderId}/payments/embedded/current":{"get":{"tags":["Payments"],"summary":"Gets the current {Vista.OmniChannel.Contracts.V1.Orders.Payments.Embedded.IOrderEmbeddedPayment} for the order.","description":"<para>\r\n            The payment considered current is the most recently created {Vista.OmniChannel.Contracts.V1.Orders.Payments.Embedded.IOrderEmbeddedPayment} for the order.\r\n            </para>\r\n<para>\r\n            This endpoint may be polled to determine the status of the payment after embedded payment process has completed on client.\r\n            This is required currently due to limitations in the current Web Payment Module payment process around returning payment status\r\n            as part of the UI interaction requiring the client to make this extra call before leaving the payment UI.\r\n            </para>","operationId":"OcapiOrderPayments_GetCurrentEmbeddedPaymentByOrderid","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"orderId","in":"path","description":"The unique identifier of the {Vista.OmniChannel.Contracts.V1.Orders.InProgressOrders.IInProgressOrderBase}.","required":true,"type":"string"},{"name":"Connect-Region-Code","in":"header","description":"Region Code","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/IOrderEmbeddedPayment&#8203;&#8203;"}},"404":{"description":"Order does not exist, or embedded payment has not been created."}},"contractResolver":{"DynamicCodeGeneration":true,"DefaultMembersSearchFlags":20,"SerializeCompilerGeneratedMembers":false,"IgnoreSerializableInterface":false,"IgnoreSerializableAttribute":true,"IgnoreIsSpecifiedMembers":false,"IgnoreShouldSerializeMembers":false,"NamingStrategy":{"ProcessDictionaryKeys":true,"ProcessExtensionDataNames":false,"OverrideSpecifiedNames":true}}}},"/ocapi/v1/orders/{orderId}/payments/redirect":{"post":{"tags":["Payments"],"summary":"Creates an {Vista.OmniChannel.Contracts.V1.Orders.Payments.Redirect.IOrderRedirectPayment}.","operationId":"OcapiOrderPayments_CreateRedirectPaymentByOrderid","consumes":["application/json","text/json","application/x-www-form-urlencoded"],"produces":["application/json","text/json"],"parameters":[{"name":"orderId","in":"path","description":"The unique identifier of the {Vista.OmniChannel.Contracts.V1.Orders.InProgressOrders.IInProgressOrderBase} that the payment is for.","required":true,"type":"string"},{"name":"request","in":"body","description":"Values needed to start the redirect payment.","required":true,"schema":{"$ref":"#/definitions/OrderRedirectPaymentCreate&#8203;&#8203;"}},{"name":"Connect-Region-Code","in":"header","description":"Region Code","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ICreatedOrderRedirectPayment&#8203;&#8203;"}},"400":{"description":"Request property is invalid or missing, or payment method does not exist."},"404":{"description":"Order does not exist."}},"contractResolver":{"DynamicCodeGeneration":true,"DefaultMembersSearchFlags":20,"SerializeCompilerGeneratedMembers":false,"IgnoreSerializableInterface":false,"IgnoreSerializableAttribute":true,"IgnoreIsSpecifiedMembers":false,"IgnoreShouldSerializeMembers":false,"NamingStrategy":{"ProcessDictionaryKeys":true,"ProcessExtensionDataNames":false,"OverrideSpecifiedNames":true}}}},"/ocapi/v1/orders/{orderId}/payments/redirect/current":{"get":{"tags":["Payments"],"summary":"Gets the current {Vista.OmniChannel.Contracts.V1.Orders.Payments.Redirect.IOrderRedirectPayment} for the order.","description":"<para>\r\n            The payment considered current is the most recently created {Vista.OmniChannel.Contracts.V1.Orders.Payments.Redirect.IOrderRedirectPayment} for the order.\r\n            </para>\r\n<para>\r\n            This endpoint may be polled to determine the status of the payment after the redirect payment process has completed on the client.\r\n            This is required currently due to limitations in the current Web Payment Module payment process around returning payment status\r\n            as part of the UI interaction requiring the client to make this extra call before leaving the payment UI.\r\n            </para>","operationId":"OcapiOrderPayments_GetCurrentRedirectPaymentByOrderid","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"orderId","in":"path","description":"The unique identifier of the {Vista.OmniChannel.Contracts.V1.Orders.InProgressOrders.IInProgressOrderBase}.","required":true,"type":"string"},{"name":"Connect-Region-Code","in":"header","description":"Region Code","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/IOrderRedirectPayment&#8203;&#8203;"}},"404":{"description":"Order does not exist, or redirect payment has not been created."}},"contractResolver":{"DynamicCodeGeneration":true,"DefaultMembersSearchFlags":20,"SerializeCompilerGeneratedMembers":false,"IgnoreSerializableInterface":false,"IgnoreSerializableAttribute":true,"IgnoreIsSpecifiedMembers":false,"IgnoreShouldSerializeMembers":false,"NamingStrategy":{"ProcessDictionaryKeys":true,"ProcessExtensionDataNames":false,"OverrideSpecifiedNames":true}}}},"/ocapi/v1/orders/{orderId}/showtimes/{showtimeId}/seat-availability":{"get":{"tags":["Seating"],"summary":"Gets the seat availability for a {Vista.OmniChannel.Contracts.V1.Browsing.MasterData.Showtimes.IShowtime} in the context of a {Vista.OmniChannel.Contracts.V1.Orders.IStandardOrder}.","description":"<para>\r\n            Using this endpoint over {M:WSVistaWebClient.Ocapi.V1.SeatingData.Availability.OcapiSeatAvailabilityController.GetSeatAvailabilityForShowtime(System.String)} enables order-specific seat availability\r\n            information and the pre-blocking of social distance seats.\r\n            </para>","operationId":"OcapiSeatAvailability_GetSeatAvailabilityForOrderByOrderidAndShowtimeid","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"orderId","in":"path","description":"The unique identifier of the {Vista.OmniChannel.Contracts.V1.Orders.IStandardOrder}.","required":true,"type":"string"},{"name":"showtimeId","in":"path","description":"The unique identifier of the {Vista.OmniChannel.Contracts.V1.Browsing.MasterData.Showtimes.IShowtime}.","required":true,"type":"string"},{"name":"Connect-Region-Code","in":"header","description":"Region Code","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/IShowtimeSeatAvailability&#8203;&#8203;"}},"404":{"description":"Order or showtime does not exist."}},"contractResolver":{"DynamicCodeGeneration":true,"DefaultMembersSearchFlags":20,"SerializeCompilerGeneratedMembers":false,"IgnoreSerializableInterface":false,"IgnoreSerializableAttribute":true,"IgnoreIsSpecifiedMembers":false,"IgnoreShouldSerializeMembers":false,"NamingStrategy":{"ProcessDictionaryKeys":true,"ProcessExtensionDataNames":false,"OverrideSpecifiedNames":true}}}},"/ocapi/v1/orders/{orderId}/showtimes/{showtimeId}":{"put":{"tags":["Showtimes"],"summary":"Sets the requested tickets and/or seats for an {Vista.OmniChannel.Contracts.V1.Orders.Showtimes.IOrderShowtime} within an {Vista.OmniChannel.Contracts.V1.Orders.InProgressOrders.IInProgressStandardOrder}.","description":"#### Specifying Tickets without Seats (Ticket-first Ordering)\r\n- If session seat allocation is marked as *None*: Tickets will be booked without specific seats\r\n- If session seat allocation is marked as *Manual*: Tickets will be booked. Seats will be auto-allocated if possible.\r\n- If session seat allocation is marked as *Auto*: Tickets will be booked. Seats will be auto-allocated if possible.\r\n\r\n#### Specifying Seats (Ticket-first and seat-first Ordering)\r\n- If session seat allocation is marked as *None*: Specifying seats is invalid - a 400 will be returned.\r\n- If session seat allocation is marked as *Manual*: Specified seats will be reserved if possible - otherwise a *SeatsUnavailable* error will be returned.\r\n- If session seat allocation is marked as *Auto*: Specified seats will be reserved if possible - otherwise a *SeatsUnavailable* error will be returned.\r\n\r\n#### Auto-Allocation\r\n- The system may attempt to auto-allocate seats if specific seats are not supplied, depending on system configuration.\r\n- The auto-allocation system is not guaranteed to allocate seats. Auto-allocation may fail if seats cannot be allocated contiguously.\r\n- When allocation fails the client must render a seat plan and the seats must be manually specified.\r\n- It is recommended the client render the seat plan regardless to provide the opportunity for the customer to modify the auto-allocated selections.\r\n#### Errors\r\n\r\n - HTTP Status **400**: Error Code **10000**: Seats unavailable\r\n - HTTP Status **400**: Error Code **17001**: Advance booking rule not met.\r\n\r\n","operationId":"OcapiOrderShowtimes_SetShowtimeByOrderidAndShowtimeid","consumes":["application/json","text/json","application/x-www-form-urlencoded"],"produces":["application/json","text/json"],"parameters":[{"name":"orderId","in":"path","description":"The unique identifier of the {Vista.OmniChannel.Contracts.V1.Orders.InProgressOrders.IInProgressStandardOrder} being modified.","required":true,"type":"string"},{"name":"showtimeId","in":"path","description":"The unique identifier of the {Vista.OmniChannel.Contracts.V1.Orders.Showtimes.IOrderShowtime} being modified.","required":true,"type":"string"},{"name":"request","in":"body","description":"The requested tickets and/or seats.","required":true,"schema":{"$ref":"#/definitions/OrderShowtimeRequest&#8203;&#8203;"}},{"name":"Connect-Region-Code","in":"header","description":"Region Code","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/IInProgressOrderDetails&#x3C;IInProgressStandardOrder&#8203;&#8203;&#x3E;&#8203;&#8203;"}},"400":{"description":"Request property is invalid or missing, or invalid order type."},"404":{"description":"Order or showtime does not exist."}},"contractResolver":{"DynamicCodeGeneration":true,"DefaultMembersSearchFlags":20,"SerializeCompilerGeneratedMembers":false,"IgnoreSerializableInterface":false,"IgnoreSerializableAttribute":true,"IgnoreIsSpecifiedMembers":false,"IgnoreShouldSerializeMembers":false,"NamingStrategy":{"ProcessDictionaryKeys":true,"ProcessExtensionDataNames":false,"OverrideSpecifiedNames":true}}}},"/ocapi/v1/orders/{orderId}/subscription":{"put":{"tags":["Subscriptions"],"summary":"Sets the subscription for an {Vista.OmniChannel.Contracts.V1.Orders.InProgressOrders.IInProgressSubscriptionOrder}.","description":"\r\n#### Errors\r\n\r\n - HTTP Status **400**: Error Code **15000**: Invalid Billing Option identifier.\r\n - HTTP Status **400**: Error Code **15001**: Invalid Member Club identifier.\r\n - HTTP Status **400**: Error Code **15002**: Current subscription term minimum required months not met.\r\n - HTTP Status **400**: Error Code **15003**: Current subscription is on hold.\r\n - HTTP Status **400**: Error Code **15004**: Current subscription is frozen.\r\n\r\n\r\n#### Licenses Required\r\n\r\n - Vista.Subscriptions\r\n\r\n","operationId":"OcapiOrderSubscriptions_SetSubscriptionForOrderByOrderid","consumes":["application/json","text/json","application/x-www-form-urlencoded"],"produces":["application/json","text/json"],"parameters":[{"name":"orderId","in":"path","description":"The unique identifier of the {Vista.OmniChannel.Contracts.V1.Orders.InProgressOrders.IInProgressSubscriptionOrder} being modified.","required":true,"type":"string"},{"name":"subscriptionRequest","in":"body","description":"The requested subscription.","required":true,"schema":{"$ref":"#/definitions/OrderSubscriptionRequest&#8203;&#8203;"}},{"name":"loyaltySessionToken","in":"header","description":"Current Loyalty session token, represents a 'signed-in' member","required":false,"type":"string"},{"name":"Connect-Region-Code","in":"header","description":"Region Code","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/IInProgressOrderDetails&#x3C;IInProgressSubscriptionOrder&#8203;&#8203;&#x3E;&#8203;&#8203;"}},"400":{"description":"Request property is invalid or missing, or invalid order type."},"401":{"description":"No member authenticated."},"404":{"description":"Order does not exist."}},"contractResolver":{"DynamicCodeGeneration":true,"DefaultMembersSearchFlags":20,"SerializeCompilerGeneratedMembers":false,"IgnoreSerializableInterface":false,"IgnoreSerializableAttribute":true,"IgnoreIsSpecifiedMembers":false,"IgnoreShouldSerializeMembers":false,"NamingStrategy":{"ProcessDictionaryKeys":true,"ProcessExtensionDataNames":false,"OverrideSpecifiedNames":true}}}},"/ocapi/v1/orders/subscription":{"post":{"tags":["Subscriptions"],"summary":"Creates an {Vista.OmniChannel.Contracts.V1.Orders.InProgressOrders.IInProgressSubscriptionOrder}.","description":"\r\n#### Licenses Required\r\n\r\n - Vista.Subscriptions\r\n\r\n","operationId":"OcapiOrders_CreateSubscriptionOrder","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"Connect-Region-Code","in":"header","description":"Region Code","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/IInProgressOrderDetails&#x3C;IInProgressSubscriptionOrder&#8203;&#8203;&#x3E;&#8203;&#8203;"}},"400":{"description":"Gift shop does not exist."}},"contractResolver":{"DynamicCodeGeneration":true,"DefaultMembersSearchFlags":20,"SerializeCompilerGeneratedMembers":false,"IgnoreSerializableInterface":false,"IgnoreSerializableAttribute":true,"IgnoreIsSpecifiedMembers":false,"IgnoreShouldSerializeMembers":false,"NamingStrategy":{"ProcessDictionaryKeys":true,"ProcessExtensionDataNames":false,"OverrideSpecifiedNames":true}}}},"/ocapi/v1/orders/{orderId}/ticket-redemption-cards":{"post":{"tags":["Ticket Redemption Cards"],"summary":"Adds a ticket redemption card to an {Vista.OmniChannel.Contracts.V1.Orders.InProgressOrders.IInProgressStandardOrder}.","description":"<para>\r\n            This endpoint validates the provided {Vista.OmniChannel.Contracts.V1.TicketRedemptionCards.IThirdPartyMemberCardCredentials} or {Vista.OmniChannel.Contracts.V1.Loyalty.Members.TicketRedemptionCards.IMemberTicketRedemptionCard}\r\n            and stores a successfully validated card against the order for later use.\r\n            </para>\r\n<para>\r\n            For {Vista.OmniChannel.Contracts.V1.Orders.TicketRedemptionCards.IOrderTicketRedemptionCard} entities of type {Vista.OmniChannel.Contracts.V1.TicketRedemptionCards.TicketRedemptionCardType.ThirdPartyMemberCard}, if the underlying\r\n            {Vista.OmniChannel.Contracts.V1.Sales.MasterData.ThirdPartyMemberSchemes.IThirdPartyMemberScheme} supports partial approvals, an arbitrarily large number of tickets will be requested to determine how\r\n            many redemptions are actually available. Cards belonging to schemes that do not support partial approval will only allow one redemption per order.\r\n            </para>\r\n#### Errors\r\n\r\n - HTTP Status **400**: Error Code **13000**: Ticket redemption card declined for showtime.\r\n - HTTP Status **400**: Error Code **13001**: Ticket redemption card already added.\r\n - HTTP Status **400**: Error Code **13002**: There is no valid ticket type for this showtime and third party member card.\r\n - HTTP Status **400**: Error Code **13003**: There are valid ticket types for this showtime and third party member card, but none for the currently selected seats.\r\n - HTTP Status **400**: Error Code **13004**: A member must be logged in. There is a valid ticket type for this showtime and third party member card, but the ticket type is restricted to Loyalty members.\r\n\r\n","operationId":"OcapiOrderTicketRedemptionCards_AddTicketRedemptionCardByOrderid","consumes":["application/json","text/json","application/x-www-form-urlencoded"],"produces":["application/json","text/json"],"parameters":[{"name":"orderId","in":"path","description":"The unique identifier of the {Vista.OmniChannel.Contracts.V1.Orders.InProgressOrders.IInProgressStandardOrder} being modified.","required":true,"type":"string"},{"name":"orderTicketRedemptionCardRequest","in":"body","description":"The details of the ticket redemption card to be added.","required":true,"schema":{"$ref":"#/definitions/OrderTicketRedemptionCardRequestBase&#8203;&#8203;"}},{"name":"loyaltySessionToken","in":"header","description":"Current Loyalty session token, represents a 'signed-in' member","required":false,"type":"string"},{"name":"Connect-Region-Code","in":"header","description":"Region Code","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/IOrderTicketRedemptionCardDetails&#8203;&#8203;"}},"400":{"description":"Request property is invalid or missing, or invalid order type/card."},"401":{"description":"No member authenticated."},"404":{"description":"Order does not exist."}},"contractResolver":{"DynamicCodeGeneration":true,"DefaultMembersSearchFlags":20,"SerializeCompilerGeneratedMembers":false,"IgnoreSerializableInterface":false,"IgnoreSerializableAttribute":true,"IgnoreIsSpecifiedMembers":false,"IgnoreShouldSerializeMembers":false,"NamingStrategy":{"ProcessDictionaryKeys":true,"ProcessExtensionDataNames":false,"OverrideSpecifiedNames":true}}}},"/ocapi/v1/orders/{orderId}/tip":{"put":{"tags":["Tips"],"summary":"Sets the tip for an {Vista.OmniChannel.Contracts.V1.Orders.InProgressOrders.IInProgressStandardOrder}.","description":"\r\n#### Errors\r\n\r\n\r\n","operationId":"OrderTips_SetOrderTipByOrderid","consumes":["application/json","text/json","application/x-www-form-urlencoded"],"produces":["application/json","text/json"],"parameters":[{"name":"orderId","in":"path","description":"The unique identifier of the {Vista.OmniChannel.Contracts.V1.Orders.InProgressOrders.IInProgressStandardOrder} being modified.","required":true,"type":"string"},{"name":"request","in":"body","description":"The tip to set.","required":true,"schema":{"$ref":"#/definitions/OrderTipRequest&#8203;&#8203;"}},{"name":"Connect-Region-Code","in":"header","description":"Region Code","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/IInProgressOrderDetails&#x3C;IInProgressStandardOrder&#8203;&#8203;&#x3E;&#8203;&#8203;"}},"404":{"description":"Order does not exist."}},"contractResolver":{"DynamicCodeGeneration":true,"DefaultMembersSearchFlags":20,"SerializeCompilerGeneratedMembers":false,"IgnoreSerializableInterface":false,"IgnoreSerializableAttribute":true,"IgnoreIsSpecifiedMembers":false,"IgnoreShouldSerializeMembers":false,"NamingStrategy":{"ProcessDictionaryKeys":true,"ProcessExtensionDataNames":false,"OverrideSpecifiedNames":true}}}},"/ocapi/v1/orders/{orderId}/vouchers":{"post":{"tags":["Vouchers"],"summary":"Adds a voucher to an {Vista.OmniChannel.Contracts.V1.Orders.InProgressOrders.IInProgressOrderBase}.","description":"<para>This endpoint validates the provided {Vista.OmniChannel.Contracts.V1.Vouchers.IVoucherCredentials} and stores a successfully validated voucher against the order for later use.</para>\r\n#### Errors\r\n\r\n - HTTP Status **400**: Error Code **12000**: Invalid barcode and/or PIN\r\n - HTTP Status **400**: Error Code **12002**: Voucher exists but is no longer able to be used due to it being invalidated in VGC\r\n - HTTP Status **400**: Error Code **12003**: No redemptions left\r\n - HTTP Status **400**: Error Code **12004**: Voucher has expired and cannot be used\r\n - HTTP Status **400**: Error Code **12006**: Voucher type is invalid for requested order (e.g. invalid order type or invalid order selections)\r\n - HTTP Status **400**: Error Code **12008**: The linked deal for this voucher is not available on this sales channel\r\n - HTTP Status **409**: Error Code **12001**: Voucher already added to the order\r\n\r\n","operationId":"OcapiOrderVouchers_AddVoucherByOrderid","consumes":["application/json","text/json","application/x-www-form-urlencoded"],"produces":["application/json","text/json"],"parameters":[{"name":"orderId","in":"path","description":"The unique identifier of the {Vista.OmniChannel.Contracts.V1.Orders.InProgressOrders.IInProgressOrderBase} being modified.","required":true,"type":"string"},{"name":"orderVoucherRequest","in":"body","description":"The details of the voucher to be added to the {Vista.OmniChannel.Contracts.V1.Orders.InProgressOrders.IInProgressOrderBase}.","required":true,"schema":{"$ref":"#/definitions/OrderVoucherRequestBase&#8203;&#8203;"}},{"name":"Connect-Region-Code","in":"header","description":"Region Code","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/IOrderVoucherDetails&#8203;&#8203;"}},"400":{"description":"Request property is invalid or missing, or invalid order type/voucher."},"404":{"description":"Order does not exist."},"429":{"description":"Too many requests. Try again later.","schema":{"$ref":"#/definitions/RateLimitExceededError&#8203;&#8203;"}}},"contractResolver":{"DynamicCodeGeneration":true,"DefaultMembersSearchFlags":20,"SerializeCompilerGeneratedMembers":false,"IgnoreSerializableInterface":false,"IgnoreSerializableAttribute":true,"IgnoreIsSpecifiedMembers":false,"IgnoreShouldSerializeMembers":false,"NamingStrategy":{"ProcessDictionaryKeys":true,"ProcessExtensionDataNames":false,"OverrideSpecifiedNames":true}}}},"/ocapi/v1/orders/{orderId}/vouchers/{voucherId}":{"delete":{"tags":["Vouchers"],"summary":"Removes a voucher from an {Vista.OmniChannel.Contracts.V1.Orders.InProgressOrders.IInProgressOrderBase}.","description":"<para>\r\n            If the voucher is not a deal voucher, all usages of the voucher on the order must be cancelled before the\r\n            voucher can be removed.\r\n            </para>\r\n#### Errors\r\n\r\n - HTTP Status **400**: Error Code **12005**: Voucher is already in use on the current order\r\n\r\n","operationId":"OcapiOrderVouchers_RemoveVoucherByOrderidAndVoucherid","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"orderId","in":"path","description":"The unique identifier of the {Vista.OmniChannel.Contracts.V1.Orders.InProgressOrders.IInProgressOrderBase} being modified.","required":true,"type":"string"},{"name":"voucherId","in":"path","description":"The unique identifier of the {Vista.OmniChannel.Contracts.V1.Orders.Vouchers.IOrderVoucher} being removed.","required":true,"type":"string"},{"name":"Connect-Region-Code","in":"header","description":"Region Code","required":false,"type":"string"}],"responses":{"204":{"description":"Voucher removed."},"400":{"description":"Voucher cannot be removed."}},"contractResolver":{"DynamicCodeGeneration":true,"DefaultMembersSearchFlags":20,"SerializeCompilerGeneratedMembers":false,"IgnoreSerializableInterface":false,"IgnoreSerializableAttribute":true,"IgnoreIsSpecifiedMembers":false,"IgnoreShouldSerializeMembers":false,"NamingStrategy":{"ProcessDictionaryKeys":true,"ProcessExtensionDataNames":false,"OverrideSpecifiedNames":true}}}}},"definitions":{"ICompletedOrderDetails&#x3C;ICompletedOrderBase&#8203;&#8203;&#x3E;&#8203;&#8203;":{"description":"Represents a {Vista.OmniChannel.Contracts.V1.Orders.CompletedOrders.ICompletedOrderBase} entity, and its related data.","required":["order","relatedData"],"type":"object","properties":{"order":{"$ref":"#/definitions/ICompletedOrderBase&#8203;&#8203;","description":"Gets the {Vista.OmniChannel.Contracts.V1.Orders.CompletedOrders.ICompletedOrderBase} entity.","readOnly":true},"relatedData":{"$ref":"#/definitions/IOrderRelatedData&#8203;&#8203;","description":"Gets the related data for the {Vista.OmniChannel.Contracts.V1.Orders.CompletedOrders.ICompletedOrderBase} entity.","readOnly":true}}},"ICompletedOrderBase&#8203;&#8203;":{"description":"Represents the base properties of an {Vista.OmniChannel.Contracts.V1.Orders.IOrderBase} in a {Vista.OmniChannel.Contracts.V1.Orders.OrderStatus.Completed} state.","required":["originalPrice","type","status","totalPrice","amountSaved","vouchers","deals","payments"],"type":"object","properties":{"originalPrice":{"$ref":"#/definitions/IMonetaryValue&#8203;&#8203;","description":"Gets the total price the customer paid for the order at the time the order was initially completed.","readOnly":true},"transaction":{"$ref":"#/definitions/IOrderTransaction&#8203;&#8203;","description":"Gets the transaction details, if applicable.","readOnly":true},"id":{"description":"Gets the unique identifier.","type":"string","readOnly":true},"type":{"format":"int32","description":"Gets the type. ['0: Standard','1: GiftShop','2: Subscription']","type":"integer","readOnly":true},"status":{"format":"int32","description":"Gets the status. ['0: InProgress','1: Completed']","type":"integer","readOnly":true},"totalPrice":{"$ref":"#/definitions/IMonetaryValue&#8203;&#8203;","description":"Gets the total price to be displayed to the customer.","readOnly":true},"amountSaved":{"$ref":"#/definitions/IMonetaryValue&#8203;&#8203;","description":"Gets the monetary amount saved via discounted prices.","readOnly":true},"vouchers":{"description":"Gets the list of {Vista.OmniChannel.Contracts.V1.Orders.Vouchers.IOrderVoucher} entities.","type":"array","items":{"$ref":"#/definitions/IOrderVoucher&#8203;&#8203;"},"readOnly":true},"deals":{"description":"Gets the list of {Vista.OmniChannel.Contracts.V1.Orders.Deals.IOrderDeal} entities.","type":"array","items":{"$ref":"#/definitions/IOrderDeal&#8203;&#8203;"},"readOnly":true},"payments":{"description":"Gets the list of {Vista.OmniChannel.Contracts.V1.Orders.Payments.IOrderPaymentBase} entities.","type":"array","items":{"$ref":"#/definitions/IOrderPaymentBase&#8203;&#8203;"},"readOnly":true}}},"IOrderRelatedData&#8203;&#8203;":{"description":"Related data for an {Vista.OmniChannel.Contracts.V1.Orders.IOrderBase} entity.","required":["films","ticketTypes","items","showtimes","sites","screens","censorRatings"],"type":"object","properties":{"films":{"description":"Gets the list of related {Vista.OmniChannel.Contracts.V1.Orders.RelatedData.IOrderRelatedFilm} entities.","type":"array","items":{"$ref":"#/definitions/IOrderRelatedFilm&#8203;&#8203;"},"readOnly":true},"ticketTypes":{"description":"Gets the list of related {Vista.OmniChannel.Contracts.V1.Orders.RelatedData.IOrderRelatedTicketType} entities.","type":"array","items":{"$ref":"#/definitions/IOrderRelatedTicketType&#8203;&#8203;"},"readOnly":true},"items":{"description":"Gets the list of related {Vista.OmniChannel.Contracts.V1.Orders.RelatedData.IOrderRelatedItem} entities.","type":"array","items":{"$ref":"#/definitions/IOrderRelatedItem&#8203;&#8203;"},"readOnly":true},"showtimes":{"description":"Gets the list of related {Vista.OmniChannel.Contracts.V1.Orders.RelatedData.IOrderRelatedShowtime} entities.","type":"array","items":{"$ref":"#/definitions/IOrderRelatedShowtime&#8203;&#8203;"},"readOnly":true},"sites":{"description":"Gets the list of related {Vista.OmniChannel.Contracts.V1.Browsing.MasterData.Sites.ISite} entities.","type":"array","items":{"$ref":"#/definitions/ISite&#8203;&#8203;"},"readOnly":true},"screens":{"description":"Gets the list of related {Vista.OmniChannel.Contracts.V1.Browsing.MasterData.Screens.IScreen} entities.","type":"array","items":{"$ref":"#/definitions/IScreen&#8203;&#8203;"},"readOnly":true},"censorRatings":{"description":"Gets the list of related {Vista.OmniChannel.Contracts.V1.Browsing.MasterData.CensorRatings.ICensorRating} entities.","type":"array","items":{"$ref":"#/definitions/ICensorRating&#8203;&#8203;"},"readOnly":true},"subscriptionBillingOption":{"$ref":"#/definitions/IOrderRelatedSubscriptionBillingOption&#8203;&#8203;","description":"Gets the related {Vista.OmniChannel.Contracts.V1.Orders.RelatedData.IOrderRelatedSubscriptionBillingOption} entity.","readOnly":true},"subscription":{"$ref":"#/definitions/IOrderRelatedSubscription&#8203;&#8203;","description":"Gets the related {Vista.OmniChannel.Contracts.V1.Orders.RelatedData.IOrderRelatedSubscription} entity.","readOnly":true},"balanceType":{"$ref":"#/definitions/IBalanceType&#8203;&#8203;","description":"Gets the related {Vista.OmniChannel.Contracts.V1.Loyalty.MasterData.BalanceTypes.IBalanceType} entity, if applicable.","readOnly":true}}},"IMonetaryValue&#8203;&#8203;":{"description":"Represents a monetary value, and its related tax value.","required":["valueIncludingTax","valueExcludingTax","tax"],"type":"object","properties":{"valueIncludingTax":{"format":"decimal","description":"Gets the monetary value including tax.","type":"number","readOnly":true},"valueExcludingTax":{"format":"decimal","description":"Gets the monetary value excluding tax.","type":"number","readOnly":true},"tax":{"format":"decimal","description":"Gets the amount of tax.","type":"number","readOnly":true}}},"IOrderTransaction&#8203;&#8203;":{"description":"Represents the transaction details of an {Vista.OmniChannel.Contracts.V1.Orders.CompletedOrders.ICompletedOrderBase}.","required":["number","barcode","createdAt"],"type":"object","properties":{"number":{"format":"int32","description":"Gets the number generated by the {Vista.OmniChannel.Contracts.V1.Browsing.MasterData.Sites.ISite} that can be used to identify and collect the transaction.","type":"integer","readOnly":true},"barcode":{"description":"Gets the barcode generated by the {Vista.OmniChannel.Contracts.V1.Browsing.MasterData.Sites.ISite} that can be used to identify and collect the transaction.","type":"string","readOnly":true},"createdAt":{"format":"date-time","description":"Gets the date and time that the transaction was created.","type":"string","readOnly":true}}},"IOrderVoucher&#8203;&#8203;":{"description":"Represents a voucher that has been added to an {Vista.OmniChannel.Contracts.V1.Orders.IOrderBase}.","required":["id","type","maskedBarcode","voucherTypeCode"],"type":"object","properties":{"id":{"description":"Gets the identifier that can be used to uniquely identify the voucher within the {Vista.OmniChannel.Contracts.V1.Orders.IOrderBase}.","type":"string","readOnly":true},"type":{"format":"int32","description":"Gets the type. ['0: Ticket','1: Subscription','2: Deal']","type":"integer","readOnly":true},"maskedBarcode":{"description":"Gets a masked representation of the barcode.","type":"string","readOnly":true},"voucherTypeCode":{"description":"Gets the unique identifier of the voucher type.","type":"string","readOnly":true},"voucherTypeDescription":{"$ref":"#/definitions/ITranslatable&#8203;&#8203;","description":"Gets the voucher type description text, and its translations.","readOnly":true}}},"IOrderDeal&#8203;&#8203;":{"description":"Represents an instance of a {Vista.OmniChannel.Contracts.V1.Sales.MasterData.Deals.IDealBase} that has been added to an {Vista.OmniChannel.Contracts.V1.Orders.IOrderBase}.","required":["id","dealId"],"type":"object","properties":{"id":{"description":"Gets the identifier that can be used to uniquely identify the deal within the {Vista.OmniChannel.Contracts.V1.Orders.IOrderBase}.","type":"string","readOnly":true},"dealId":{"description":"Gets the unique identifier of the {Vista.OmniChannel.Contracts.V1.Sales.MasterData.Deals.IDealBase} used.","type":"string","readOnly":true},"voucherId":{"description":"Gets the unique identifier of the {Vista.OmniChannel.Contracts.V1.Orders.Vouchers.IOrderVoucher} used, if applicable.","type":"string","readOnly":true}}},"IOrderPaymentBase&#8203;&#8203;":{"description":"Represents the base properties of a payment that has been added to an {Vista.OmniChannel.Contracts.V1.Orders.IOrderBase}.","required":["id","type","value","status"],"type":"object","properties":{"id":{"description":"Gets the identifier that can be used to uniquely identify the payment within the {Vista.OmniChannel.Contracts.V1.Orders.IOrderBase}.","type":"string","readOnly":true},"type":{"format":"int32","description":"Gets the type. ['0: CinemaProcessed','1: Embedded','2: GiftCard','3: Redirect','4: MemberBalance']","type":"integer","readOnly":true},"value":{"format":"decimal","description":"Gets the monetary value.","type":"number","readOnly":true},"status":{"format":"int32","description":"Gets the status. ['0: NotStarted','1: Pending','2: Declined','3: Completed']","type":"integer","readOnly":true}}},"IOrderRelatedFilm&#8203;&#8203;":{"description":"Represents the {Vista.OmniChannel.Contracts.V1.Browsing.MasterData.Films.IFilm} data related to an {Vista.OmniChannel.Contracts.V1.Orders.IOrderBase}.","required":["id","title","externalIds"],"type":"object","properties":{"id":{"type":"string","readOnly":true},"title":{"$ref":"#/definitions/ITranslatable&#8203;&#8203;","readOnly":true},"censorRatingId":{"type":"string","readOnly":true},"censorRatingNote":{"$ref":"#/definitions/ITranslatable&#8203;&#8203;","readOnly":true},"externalIds":{"$ref":"#/definitions/IFilmExternalIds&#8203;&#8203;","readOnly":true}}},"IOrderRelatedTicketType&#8203;&#8203;":{"description":"Represents the {Vista.OmniChannel.Contracts.V1.Sales.MasterData.TicketTypes.ITicketTypeBase} data related to an {Vista.OmniChannel.Contracts.V1.Orders.IOrderBase}.","required":["id","description"],"type":"object","properties":{"id":{"type":"string","readOnly":true},"description":{"$ref":"#/definitions/ITranslatable&#8203;&#8203;","readOnly":true}}},"IOrderRelatedItem&#8203;&#8203;":{"description":"Represents the {Vista.OmniChannel.Contracts.V1.Sales.MasterData.Items.IItemBase} data related to an {Vista.OmniChannel.Contracts.V1.Orders.IOrderBase}.","required":["id","name","hoCode"],"type":"object","properties":{"isSundry":{"description":"Gets a value indicating whether this is a sundry item.","type":"boolean","readOnly":true},"id":{"description":"Gets the unique identifier.","type":"string","readOnly":true},"name":{"$ref":"#/definitions/ITranslatable&#8203;&#8203;","description":"Gets the name text, and its translations.","readOnly":true},"hoCode":{"description":"Gets the Head Office code.","type":"string","readOnly":true},"hopk":{"description":"Gets the Head Office primary key.","type":"string","readOnly":true}}},"IOrderRelatedShowtime&#8203;&#8203;":{"description":"Represents the {Vista.OmniChannel.Contracts.V1.Browsing.MasterData.Showtimes.IShowtime} data related to an {Vista.OmniChannel.Contracts.V1.Orders.IOrderBase}.","required":["id","schedule","filmId","siteId","screenId"],"type":"object","properties":{"id":{"type":"string","readOnly":true},"schedule":{"$ref":"#/definitions/IShowtimeSchedule&#8203;&#8203;","readOnly":true},"filmId":{"type":"string","readOnly":true},"siteId":{"type":"string","readOnly":true},"screenId":{"type":"string","readOnly":true}}},"ISite&#8203;&#8203;":{"description":"Represents a physical location that belongs to a cinema chain, consisting of one or more {Vista.OmniChannel.Contracts.V1.Browsing.MasterData.Screens.IScreen} entities.","required":["contactDetails","ianaTimeZoneName","id","name"],"type":"object","properties":{"location":{"$ref":"#/definitions/IGeographicLocation&#8203;&#8203;","description":"Gets the geographic location.","readOnly":true},"contactDetails":{"$ref":"#/definitions/ISiteContactDetails&#8203;&#8203;","description":"Gets the contact details.","readOnly":true},"ianaTimeZoneName":{"description":"Gets the IANA time zone name.","type":"string","readOnly":true},"id":{"description":"Gets the unique identifier.","type":"string","readOnly":true},"name":{"$ref":"#/definitions/ITranslatable&#8203;&#8203;","description":"Gets the name text, and its translations.","readOnly":true}}},"IScreen&#8203;&#8203;":{"description":"Represents a room belonging to a {Vista.OmniChannel.Contracts.V1.Browsing.MasterData.Sites.ISite} where {Vista.OmniChannel.Contracts.V1.Browsing.MasterData.Films.IFilm} entities are screened.","required":["id","name"],"type":"object","properties":{"id":{"description":"Gets the unique identifier.","type":"string","readOnly":true},"name":{"$ref":"#/definitions/ITranslatable&#8203;&#8203;","description":"Gets the name text, and its translations.","readOnly":true}}},"ICensorRating&#8203;&#8203;":{"description":"Represents the censor rating of a {Vista.OmniChannel.Contracts.V1.Browsing.MasterData.Films.IFilm}, e.g. R18.","required":["id","classification"],"type":"object","properties":{"id":{"description":"Gets the unique identifier.","type":"string","readOnly":true},"classification":{"$ref":"#/definitions/ITranslatable&#8203;&#8203;","description":"Gets the classification text, and its translations.","readOnly":true},"classificationDescription":{"$ref":"#/definitions/ITranslatable&#8203;&#8203;","description":"Gets the {Vista.OmniChannel.Contracts.V1.Browsing.MasterData.CensorRatings.ICensorRating.Classification} description text, and its translations.","readOnly":true},"ageRestriction":{"$ref":"#/definitions/ICensorRatingAgeRestriction&#8203;&#8203;","description":"Gets the age restriction, if applicable.","readOnly":true}}},"IOrderRelatedSubscriptionBillingOption&#8203;&#8203;":{"description":"Represents the {Vista.OmniChannel.Contracts.V1.Sales.MasterData.SubscriptionBillingOptions.ISubscriptionBillingOption} data related to a {Vista.OmniChannel.Contracts.V1.Orders.ISubscriptionOrder}.","required":["subscriptionId","billingPeriodInMonths","isRecurring","id","name"],"type":"object","properties":{"subscriptionId":{"format":"int32","type":"integer","readOnly":true},"billingPeriodInMonths":{"format":"int32","type":"integer","readOnly":true},"isRecurring":{"type":"boolean","readOnly":true},"id":{"description":"Gets the unique identifier.","type":"string","readOnly":true},"name":{"$ref":"#/definitions/ITranslatable&#8203;&#8203;","description":"Gets the name text, and its translations.","readOnly":true}}},"IOrderRelatedSubscription&#8203;&#8203;":{"description":"Represents the {Vista.OmniChannel.Contracts.V1.Loyalty.MasterData.Subscriptions.ISubscription} data related to a {Vista.OmniChannel.Contracts.V1.Orders.ISubscriptionOrder}.","required":["id","name"],"type":"object","properties":{"id":{"format":"int32","description":"Gets the unique identifier.","type":"integer","readOnly":true},"name":{"$ref":"#/definitions/ITranslatable&#8203;&#8203;","description":"Gets the name text, and its translations.","readOnly":true}}},"IBalanceType&#8203;&#8203;":{"description":"Represents an account in Vista Loyalty that tracks the spending or activity of a {Vista.OmniChannel.Contracts.V1.Loyalty.Members.IMember}.","required":["isPrimary","id","name"],"type":"object","properties":{"isPrimary":{"description":"Gets a value indicating whether this is the primary balance type.","type":"boolean","readOnly":true},"unitName":{"description":"Gets the name of the balance units.","type":"string","readOnly":true},"paymentConversionRate":{"format":"double","description":"Gets the conversion rate that applies when using balance units for an {Vista.OmniChannel.Contracts.V1.Orders.Payments.MemberBalance.IOrderMemberBalancePayment}, if applicable.","type":"number","readOnly":true},"id":{"format":"int32","description":"Gets the unique identifier.","type":"integer","readOnly":true},"name":{"$ref":"#/definitions/ITranslatable&#8203;&#8203;","description":"Gets the name text, and its translations.","readOnly":true}}},"ITranslatable&#8203;&#8203;":{"description":"Represents some customer-visible {Vista.OmniChannel.Contracts.V1.ITranslatable.Text} in the default language, and a list of {Vista.OmniChannel.Contracts.V1.ITranslation} entities.","required":["text","translations"],"type":"object","properties":{"text":{"description":"Gets the text in the default language.","type":"string","readOnly":true},"translations":{"description":"Gets the translations of the {Vista.OmniChannel.Contracts.V1.ITranslatable.Text} in other languages.","type":"array","items":{"$ref":"#/definitions/ITranslation&#8203;&#8203;"},"readOnly":true}}},"IFilmExternalIds&#8203;&#8203;":{"description":"Represents the external identifiers linked to a {Vista.OmniChannel.Contracts.V1.Browsing.MasterData.Films.IFilm}.","type":"object","properties":{"moviexchangeReleaseId":{"format":"uuid","description":"Gets the unique identifier of the linked movieXchange film release entity.","type":"string","readOnly":true},"corporateId":{"description":"Gets the unique corporate identifier.","type":"string","readOnly":true}}},"IShowtimeSchedule&#8203;&#8203;":{"description":"Represents the dates and times relevant to a {Vista.OmniChannel.Contracts.V1.Browsing.MasterData.Showtimes.IShowtime}, e.g. its start, end, film start, etc.","required":["businessDate","startsAt","endsAt","filmStartsAt","filmEndsAt"],"type":"object","properties":{"businessDate":{"format":"date-time","description":"Gets the {Vista.OmniChannel.Contracts.V1.Browsing.MasterData.Showtimes.IShowtime} entity's business date.","type":"string","readOnly":true},"startsAt":{"format":"date-time","description":"Gets the date and time that the {Vista.OmniChannel.Contracts.V1.Browsing.MasterData.Showtimes.IShowtime} starts.","type":"string","readOnly":true},"endsAt":{"format":"date-time","description":"Gets the date and time that the {Vista.OmniChannel.Contracts.V1.Browsing.MasterData.Showtimes.IShowtime} ends.","type":"string","readOnly":true},"filmStartsAt":{"format":"date-time","description":"Gets the date and time that the {Vista.OmniChannel.Contracts.V1.Browsing.MasterData.Films.IFilm} screening starts.","type":"string","readOnly":true},"filmEndsAt":{"format":"date-time","description":"Gets the date and time that the {Vista.OmniChannel.Contracts.V1.Browsing.MasterData.Films.IFilm} screening ends.","type":"string","readOnly":true}}},"IGeographicLocation&#8203;&#8203;":{"description":"Represents a set of geospatial coordinates; longitude and latitude, that can be used to pinpoint a\r\nlocation on a map.","required":["latitude","longitude"],"type":"object","properties":{"latitude":{"format":"decimal","description":"Gets the latitude (expressed in degrees and minutes).","type":"number","readOnly":true},"longitude":{"format":"decimal","description":"Gets the longitude (expressed in degrees and minutes).","type":"number","readOnly":true}}},"ISiteContactDetails&#8203;&#8203;":{"description":"Represents the contact details of a {Vista.OmniChannel.Contracts.V1.Browsing.MasterData.Sites.ISite}.","required":["phoneNumbers"],"type":"object","properties":{"address":{"$ref":"#/definitions/ISiteAddress&#8203;&#8203;","description":"Gets the physical address.","readOnly":true},"email":{"description":"Gets the email address.","type":"string","readOnly":true},"phoneNumbers":{"description":"Gets the list of {Vista.OmniChannel.Contracts.V1.IPhoneNumber} entities.","type":"array","items":{"$ref":"#/definitions/IPhoneNumber&#8203;&#8203;"},"readOnly":true}}},"ICensorRatingAgeRestriction&#8203;&#8203;":{"description":"Represents the age restriction of a {Vista.OmniChannel.Contracts.V1.Browsing.MasterData.CensorRatings.ICensorRating}.","required":["minimumAge"],"type":"object","properties":{"minimumAge":{"format":"int32","description":"Gets the minimum age required.","type":"integer","readOnly":true}}},"ITranslation&#8203;&#8203;":{"description":"Represents some translated customer-visible {Vista.OmniChannel.Contracts.V1.ITranslation.Text}.","required":["languageTag","text"],"type":"object","properties":{"languageTag":{"description":"Gets the IETF (RFC 4646) language tag that the {Vista.OmniChannel.Contracts.V1.ITranslation.Text} has been translated for.","type":"string","readOnly":true},"text":{"description":"Gets the translated text.","type":"string","readOnly":true}}},"ISiteAddress&#8203;&#8203;":{"description":"Represents the physical address of a {Vista.OmniChannel.Contracts.V1.Browsing.MasterData.Sites.ISite}.","type":"object","properties":{"line1":{"description":"Gets the first line.","type":"string","readOnly":true},"line2":{"description":"Gets the second line.","type":"string","readOnly":true},"city":{"description":"Gets the city.","type":"string","readOnly":true}}},"IPhoneNumber&#8203;&#8203;":{"description":"Represents a phone number.","required":["type","number"],"type":"object","properties":{"type":{"format":"int32","description":"Gets the type. ['0: Home','1: Mobile','2: Work','3: Business','4: Fax']","type":"integer","readOnly":true},"number":{"description":"Gets the phone number.","type":"string","readOnly":true}}},"OrderShowtimeSeatSwapRequest&#8203;&#8203;":{"required":["seats"],"type":"object","properties":{"seats":{"type":"array","items":{"type":"string"}}}},"ICompletedOrderDetails&#x3C;ICompletedStandardOrder&#8203;&#8203;&#x3E;&#8203;&#8203;":{"description":"Represents a {Vista.OmniChannel.Contracts.V1.Orders.CompletedOrders.ICompletedOrderBase} entity, and its related data.","required":["order","relatedData"],"type":"object","properties":{"order":{"$ref":"#/definitions/ICompletedStandardOrder&#8203;&#8203;","description":"Gets the {Vista.OmniChannel.Contracts.V1.Orders.CompletedOrders.ICompletedOrderBase} entity.","readOnly":true},"relatedData":{"$ref":"#/definitions/IOrderRelatedData&#8203;&#8203;","description":"Gets the related data for the {Vista.OmniChannel.Contracts.V1.Orders.CompletedOrders.ICompletedOrderBase} entity.","readOnly":true}}},"ICompletedStandardOrder&#8203;&#8203;":{"description":"Represents a {Vista.OmniChannel.Contracts.V1.Orders.IStandardOrder} in a {Vista.OmniChannel.Contracts.V1.Orders.OrderStatus.Completed} state.","required":["showtimes","items","ticketRedemptionCards","siteId","type","status","totalPrice","amountSaved","vouchers","deals","payments","originalPrice"],"type":"object","properties":{"booking":{"$ref":"#/definitions/ICompletedOrderBooking&#8203;&#8203;","description":"Gets the booking details.","readOnly":true},"preparation":{"$ref":"#/definitions/IOrderPreparation&#8203;&#8203;","description":"Gets the preparation and collection details.","readOnly":true},"journeyReference":{"description":"Gets the identifier created on order completion that will be linked to a {Vista.OmniChannel.Contracts.V1.Journeys.IJourney} entity.","type":"string","readOnly":true},"showtimes":{"description":"Gets the list of {Vista.OmniChannel.Contracts.V1.Orders.Showtimes.IOrderShowtime} entities.","type":"array","items":{"$ref":"#/definitions/IOrderShowtime&#8203;&#8203;"},"readOnly":true},"items":{"description":"Gets the list of {Vista.OmniChannel.Contracts.V1.Orders.Items.IOrderItemLineBase} entities.","type":"array","items":{"$ref":"#/definitions/IOrderItemLineBase&#8203;&#8203;"},"readOnly":true},"ticketRedemptionCards":{"description":"Gets the list of {Vista.OmniChannel.Contracts.V1.Orders.TicketRedemptionCards.IOrderTicketRedemptionCard} entities.","type":"array","items":{"$ref":"#/definitions/IOrderTicketRedemptionCard&#8203;&#8203;"},"readOnly":true},"siteId":{"description":"Gets the unique identifier of the {Vista.OmniChannel.Contracts.V1.Browsing.MasterData.Sites.ISite}.","type":"string","readOnly":true},"tip":{"$ref":"#/definitions/IOrderTip&#8203;&#8203;","description":"Gets the tip.","readOnly":true},"id":{"description":"Gets the unique identifier.","type":"string","readOnly":true},"type":{"format":"int32","description":"Gets the type. ['0: Standard','1: GiftShop','2: Subscription']","type":"integer","readOnly":true},"status":{"format":"int32","description":"Gets the status. ['0: InProgress','1: Completed']","type":"integer","readOnly":true},"totalPrice":{"$ref":"#/definitions/IMonetaryValue&#8203;&#8203;","description":"Gets the total price to be displayed to the customer.","readOnly":true},"amountSaved":{"$ref":"#/definitions/IMonetaryValue&#8203;&#8203;","description":"Gets the monetary amount saved via discounted prices.","readOnly":true},"vouchers":{"description":"Gets the list of {Vista.OmniChannel.Contracts.V1.Orders.Vouchers.IOrderVoucher} entities.","type":"array","items":{"$ref":"#/definitions/IOrderVoucher&#8203;&#8203;"},"readOnly":true},"deals":{"description":"Gets the list of {Vista.OmniChannel.Contracts.V1.Orders.Deals.IOrderDeal} entities.","type":"array","items":{"$ref":"#/definitions/IOrderDeal&#8203;&#8203;"},"readOnly":true},"payments":{"description":"Gets the list of {Vista.OmniChannel.Contracts.V1.Orders.Payments.IOrderPaymentBase} entities.","type":"array","items":{"$ref":"#/definitions/IOrderPaymentBase&#8203;&#8203;"},"readOnly":true},"originalPrice":{"$ref":"#/definitions/IMonetaryValue&#8203;&#8203;","description":"Gets the total price the customer paid for the order at the time the order was initially completed.","readOnly":true},"transaction":{"$ref":"#/definitions/IOrderTransaction&#8203;&#8203;","description":"Gets the transaction details, if applicable.","readOnly":true}}},"ICompletedOrderBooking&#8203;&#8203;":{"description":"Represents the booking details of a {Vista.OmniChannel.Contracts.V1.Orders.CompletedOrders.ICompletedStandardOrder}.","required":["id","originalBookingFee","mode","totalBookingFee"],"type":"object","properties":{"id":{"description":"Gets the identifier generated by the {Vista.OmniChannel.Contracts.V1.Browsing.MasterData.Sites.ISite} that can be used to identify and collect the booking.","type":"string","readOnly":true},"originalBookingFee":{"$ref":"#/definitions/IMonetaryValue&#8203;&#8203;","description":"Gets the total booking fee amount for the order at the time it was initially made.","readOnly":true},"mode":{"format":"int32","description":"Gets the order booking mode. ['0: Paid','1: Unpaid','2: UnpaidConfirmed']","type":"integer","readOnly":true},"totalBookingFee":{"$ref":"#/definitions/IMonetaryValue&#8203;&#8203;","description":"Gets the total booking fee amount the customer has currently paid.","readOnly":true}}},"IOrderPreparation&#8203;&#8203;":{"description":"Represents the preparation and collection details of a {Vista.OmniChannel.Contracts.V1.Orders.CompletedOrders.ICompletedStandardOrder}.","required":["status"],"type":"object","properties":{"collectionNumber":{"format":"int32","description":"Gets the number generated by the {Vista.OmniChannel.Contracts.V1.Browsing.MasterData.Sites.ISite} that can be used to collect the {Vista.OmniChannel.Contracts.V1.Orders.CompletedOrders.ICompletedStandardOrder} when the {Vista.OmniChannel.Contracts.V1.Orders.Preparations.IOrderPreparation.Status}\r\nequals {Vista.OmniChannel.Contracts.V1.Orders.Preparations.OrderPreparationStatus.Completed}.","type":"integer","readOnly":true},"status":{"format":"int32","description":"Gets the current status. ['0: NotStarted','1: Started','2: Completed','3: Collected','4: Cancelled']","type":"integer","readOnly":true}}},"IOrderShowtime&#8203;&#8203;":{"description":"Represents the selected tickets and/or seats for a {Vista.OmniChannel.Contracts.V1.Browsing.MasterData.Showtimes.IShowtime} within a {Vista.OmniChannel.Contracts.V1.Orders.IStandardOrder}.","required":["showtimeId","tickets","seats","seatSwapStatus"],"type":"object","properties":{"showtimeId":{"description":"Gets the unique identifier of the {Vista.OmniChannel.Contracts.V1.Browsing.MasterData.Showtimes.IShowtime}.","type":"string","readOnly":true},"tickets":{"description":"Gets the list of {Vista.OmniChannel.Contracts.V1.Orders.Tickets.IOrderTicketLineBase} entities.","type":"array","items":{"$ref":"#/definitions/IOrderTicketLineBase&#8203;&#8203;"},"readOnly":true},"seats":{"description":"Gets the list of {Vista.OmniChannel.Contracts.V1.Orders.Seats.IOrderSeat} entities.","type":"array","items":{"$ref":"#/definitions/IOrderSeat&#8203;&#8203;"},"readOnly":true},"seatSwapStatus":{"$ref":"#/definitions/IOrderShowtimeSeatSwapStatus&#8203;&#8203;","description":"Gets the seat swap status.","readOnly":true}}},"IOrderItemLineBase&#8203;&#8203;":{"description":"Represents the base properties of an {Vista.OmniChannel.Contracts.V1.Orders.Lines.IOrderLine} for a top-level instance of an {Vista.OmniChannel.Contracts.V1.Sales.MasterData.Items.IItemBase}\r\nwithin a {Vista.OmniChannel.Contracts.V1.Orders.IStandardOrder} or {Vista.OmniChannel.Contracts.V1.Orders.IGiftShopOrder}.","required":["itemId","type","price","amountSaved","id","collectionStatus","refundStatus"],"type":"object","properties":{"rewardId":{"format":"int32","description":"Gets the unique identifier of the {Vista.OmniChannel.Contracts.V1.Loyalty.MasterData.Rewards.IReward} used, if applicable.","type":"integer","readOnly":true},"discountId":{"description":"Gets the unique identifier of the {Vista.OmniChannel.Contracts.V1.Sales.MasterData.Discounts.IDiscount} used, if applicable.","type":"string","readOnly":true},"dealId":{"description":"Gets the unique identifier of the {Vista.OmniChannel.Contracts.V1.Orders.Deals.IOrderDeal} used, if applicable.","type":"string","readOnly":true},"itemId":{"description":"Gets the unique identifier of the {Vista.OmniChannel.Contracts.V1.Sales.MasterData.Items.IItemBase}.","type":"string","readOnly":true},"type":{"format":"int32","description":"Gets the item type. ['0: Normal','1: ParentSales','2: Package','3: Recipe']","type":"integer","readOnly":true},"price":{"$ref":"#/definitions/IMonetaryValue&#8203;&#8203;","description":"Gets the price to be displayed to the customer.","readOnly":true},"amountSaved":{"$ref":"#/definitions/IMonetaryValue&#8203;&#8203;","description":"Gets the total amount saved on the item due to all discounts and deals.","readOnly":true},"parentSalesItemId":{"description":"Gets the unique identifier of the {Vista.OmniChannel.Contracts.V1.Sales.MasterData.Items.ParentSales.IParentSalesItem} this item is an option for.","type":"string","readOnly":true},"id":{"description":"Gets the identifier that can be used to uniquely identify the line within the {Vista.OmniChannel.Contracts.V1.Orders.IOrderBase}.","type":"string","readOnly":true},"collectionStatus":{"format":"int32","description":"Gets the collection status. ['0: NotCollected','1: Collected']","type":"integer","readOnly":true},"refundStatus":{"format":"int32","description":"Gets the refund status. ['0: NotRefunded','1: Refunded']","type":"integer","readOnly":true}}},"IOrderTicketRedemptionCard&#8203;&#8203;":{"description":"Represents a {Vista.OmniChannel.Contracts.V1.TicketRedemptionCards.ITicketRedemptionCardBase} that has been added to a {Vista.OmniChannel.Contracts.V1.Orders.IStandardOrder}.","required":["id","type","maskedCardNumber"],"type":"object","properties":{"id":{"format":"uuid","description":"Gets the unique identifier.","type":"string","readOnly":true},"type":{"format":"int32","description":"Gets the type. ['0: MemberSubscriptionCard','1: ThirdPartyMemberCard']","type":"integer","readOnly":true},"maskedCardNumber":{"description":"Gets a masked representation of the card number.","type":"string","readOnly":true},"subscriptionId":{"format":"int32","description":"Gets the unique identifier of the {Vista.OmniChannel.Contracts.V1.Loyalty.MasterData.Subscriptions.ISubscription} the card is linked to.","type":"integer","readOnly":true},"thirdPartyMemberSchemeId":{"description":"Gets the unique identifier of the {Vista.OmniChannel.Contracts.V1.Sales.MasterData.ThirdPartyMemberSchemes.IThirdPartyMemberScheme} the card belongs to.","type":"string","readOnly":true},"memberName":{"$ref":"#/definitions/IPersonName&#8203;&#8203;","description":"Gets the name of the person that owns the card, if known.","readOnly":true}}},"IOrderTip&#8203;&#8203;":{"description":"Represents the tip associated with a {Vista.OmniChannel.Contracts.V1.Orders.IStandardOrder}.","required":["amount","id","collectionStatus","refundStatus"],"type":"object","properties":{"amount":{"$ref":"#/definitions/IMonetaryValue&#8203;&#8203;","description":"Gets the monetary amount.","readOnly":true},"id":{"description":"Gets the identifier that can be used to uniquely identify the line within the {Vista.OmniChannel.Contracts.V1.Orders.IOrderBase}.","type":"string","readOnly":true},"collectionStatus":{"format":"int32","description":"Gets the collection status. ['0: NotCollected','1: Collected']","type":"integer","readOnly":true},"refundStatus":{"format":"int32","description":"Gets the refund status. ['0: NotRefunded','1: Refunded']","type":"integer","readOnly":true}}},"IOrderTicketLineBase&#8203;&#8203;":{"description":"Represents the base properties of an {Vista.OmniChannel.Contracts.V1.Orders.Lines.IOrderLine} for an instance of a {Vista.OmniChannel.Contracts.V1.Sales.MasterData.TicketTypes.ITicketTypeBase} within an {Vista.OmniChannel.Contracts.V1.Orders.Showtimes.IOrderShowtime}.","required":["ticketTypeId","type","price","amountSaved","id","collectionStatus","refundStatus"],"type":"object","properties":{"ticketTypeId":{"description":"Gets the unique identifier of the {Vista.OmniChannel.Contracts.V1.Sales.MasterData.TicketTypes.ITicketTypeBase}.","type":"string","readOnly":true},"type":{"format":"int32","description":"Gets the type. ['0: Normal','1: Package']","type":"integer","readOnly":true},"price":{"$ref":"#/definitions/IMonetaryValue&#8203;&#8203;","description":"Gets the price to be displayed to the customer.","readOnly":true},"amountSaved":{"$ref":"#/definitions/IMonetaryValue&#8203;&#8203;","description":"Gets the total amount saved on the ticket due to all discounts and deals.","readOnly":true},"bookingFee":{"$ref":"#/definitions/IOrderBookingFeeLine&#8203;&#8203;","description":"Gets the booking fee incurred for the ticket, if applicable.","readOnly":true},"rewardId":{"format":"int32","description":"Gets the unique identifier of the {Vista.OmniChannel.Contracts.V1.Loyalty.MasterData.Rewards.IReward} used, if applicable.","type":"integer","readOnly":true},"ticketRedemptionCardId":{"format":"uuid","description":"Gets the unique identifier of the {Vista.OmniChannel.Contracts.V1.Orders.TicketRedemptionCards.IOrderTicketRedemptionCard} used, if applicable.","type":"string","readOnly":true},"voucherId":{"description":"Gets the unique identifier of the {Vista.OmniChannel.Contracts.V1.Orders.Vouchers.IOrderVoucher} used, if applicable.","type":"string","readOnly":true},"discountId":{"description":"Gets the unique identifier of the {Vista.OmniChannel.Contracts.V1.Sales.MasterData.Discounts.IDiscount} used, if applicable.","type":"string","readOnly":true},"dealId":{"description":"Gets the unique identifier of the {Vista.OmniChannel.Contracts.V1.Orders.Deals.IOrderDeal} used, if applicable.","type":"string","readOnly":true},"id":{"description":"Gets the identifier that can be used to uniquely identify the line within the {Vista.OmniChannel.Contracts.V1.Orders.IOrderBase}.","type":"string","readOnly":true},"collectionStatus":{"format":"int32","description":"Gets the collection status. ['0: NotCollected','1: Collected']","type":"integer","readOnly":true},"refundStatus":{"format":"int32","description":"Gets the refund status. ['0: NotRefunded','1: Refunded']","type":"integer","readOnly":true}}},"IOrderSeat&#8203;&#8203;":{"description":"Represents a {Vista.OmniChannel.Contracts.V1.Seating.MasterData.ISeat} that has been allocated to an {Vista.OmniChannel.Contracts.V1.Orders.Showtimes.IOrderShowtime}.","required":["seatId","areaCategoryId","position","rowLabel","areaName"],"type":"object","properties":{"seatId":{"description":"Gets the unique identifier of the {Vista.OmniChannel.Contracts.V1.Seating.MasterData.ISeat}.","type":"string","readOnly":true},"areaCategoryId":{"description":"Gets the unique identifier of the {Vista.OmniChannel.Contracts.V1.Seating.MasterData.IAreaCategory} the seat belongs to.","type":"string","readOnly":true},"position":{"$ref":"#/definitions/ISeatPosition&#8203;&#8203;","description":"Gets the seat position.","readOnly":true},"seatLabel":{"description":"Gets the label/physical name of the {Vista.OmniChannel.Contracts.V1.Seating.MasterData.ISeat}.","type":"string","readOnly":true},"rowLabel":{"description":"Gets the label/physical name of the {Vista.OmniChannel.Contracts.V1.Seating.MasterData.IRow}.","type":"string","readOnly":true},"areaName":{"$ref":"#/definitions/ITranslatable&#8203;&#8203;","description":"Gets the {Vista.OmniChannel.Contracts.V1.Seating.MasterData.IArea} name text, and its translations.","readOnly":true}}},"IOrderShowtimeSeatSwapStatus&#8203;&#8203;":{"description":"Represents the status of the seat swap availability for an {Vista.OmniChannel.Contracts.V1.Orders.Showtimes.IOrderShowtime}.","required":["isAvailable","unavailableReason"],"type":"object","properties":{"isAvailable":{"description":"Gets a value indicating whether the {Vista.OmniChannel.Contracts.V1.Orders.Showtimes.IOrderShowtime.Seats} can be swapped.","type":"boolean","readOnly":true},"unavailableReason":{"format":"int32","description":"Gets the reason why the seats cannot be swapped. ['0: NotApplicable','1: NotEnabled','2: UnallocatedSeating','3: NoSeats','4: PackageTickets','5: InSeatDeliveryItems','6: OrderNotCompleted','7: OrderRefunded','8: UnpaidBooking']","type":"integer","readOnly":true}}},"IPersonName&#8203;&#8203;":{"description":"Represents the parts of a person's name.","type":"object","properties":{"givenName":{"description":"Gets the given name.","type":"string","readOnly":true},"middleName":{"description":"Gets the middle or any additional name.","type":"string","readOnly":true},"familyName":{"description":"Gets the family name.","type":"string","readOnly":true}}},"IOrderBookingFeeLine&#8203;&#8203;":{"description":"Represents a booking fee incurred by an {Vista.OmniChannel.Contracts.V1.Orders.Tickets.IOrderTicketLineBase}.","required":["amount","id","collectionStatus","refundStatus"],"type":"object","properties":{"amount":{"$ref":"#/definitions/IMonetaryValue&#8203;&#8203;","description":"Gets the monetary amount to be displayed to the customer.","readOnly":true},"id":{"description":"Gets the identifier that can be used to uniquely identify the line within the {Vista.OmniChannel.Contracts.V1.Orders.IOrderBase}.","type":"string","readOnly":true},"collectionStatus":{"format":"int32","description":"Gets the collection status. ['0: NotCollected','1: Collected']","type":"integer","readOnly":true},"refundStatus":{"format":"int32","description":"Gets the refund status. ['0: NotRefunded','1: Refunded']","type":"integer","readOnly":true}}},"ISeatPosition&#8203;&#8203;":{"description":"Represents the position of a {Vista.OmniChannel.Contracts.V1.Seating.MasterData.ISeat} within the {Vista.OmniChannel.Contracts.V1.Seating.MasterData.ISeatLayout}.","required":["areaNumber","rowNumber","columnNumber"],"type":"object","properties":{"areaNumber":{"format":"int32","description":"Gets the number that can be used to uniquely identify the {Vista.OmniChannel.Contracts.V1.Seating.MasterData.IArea} within the {Vista.OmniChannel.Contracts.V1.Seating.MasterData.ISeatLayout}.","type":"integer","readOnly":true},"rowNumber":{"format":"int32","description":"Gets the number that can be used to uniquely identify the {Vista.OmniChannel.Contracts.V1.Seating.MasterData.IRow} within the {Vista.OmniChannel.Contracts.V1.Seating.MasterData.IArea}.","type":"integer","readOnly":true},"columnNumber":{"format":"int32","description":"Gets the number that can be used to uniquely identify the column of the {Vista.OmniChannel.Contracts.V1.Seating.MasterData.ISeat} entity within the {Vista.OmniChannel.Contracts.V1.Seating.MasterData.IArea}.","type":"integer","readOnly":true}}},"ICompletedStandardOrderIdentifiers&#8203;&#8203;":{"description":"Represents the unique identifiers of a {Vista.OmniChannel.Contracts.V1.Orders.CompletedOrders.ICompletedStandardOrder}.","required":["orderId","journeyReference","siteId","bookingId"],"type":"object","properties":{"orderId":{"type":"string","readOnly":true},"journeyReference":{"type":"string","readOnly":true},"siteId":{"type":"string","readOnly":true},"bookingId":{"type":"string","readOnly":true},"transactionNumber":{"format":"int32","type":"integer","readOnly":true}}},"ICompletedOrderPrintStreams&#8203;&#8203;":{"description":"Represents the printable print streams for a {Vista.OmniChannel.Contracts.V1.Orders.CompletedOrders.ICompletedOrderBase}.","required":["itemCollectionVouchers","tickets","orderReceipts"],"type":"object","properties":{"itemCollectionVouchers":{"description":"Gets the printable item collection vouchers.","type":"array","items":{"type":"string"},"readOnly":true},"tickets":{"description":"Gets the printable tickets.","type":"array","items":{"type":"string"},"readOnly":true},"orderReceipts":{"description":"Gets the printable order receipts.","type":"array","items":{"type":"string"},"readOnly":true}}},"IOrderCompletion&#8203;&#8203;":{"description":"Represents the completion of an {Vista.OmniChannel.Contracts.V1.Orders.InProgressOrders.IInProgressOrderBase}.","required":["orderId","orderType","status"],"type":"object","properties":{"orderId":{"description":"Gets the unique identifier of the {Vista.OmniChannel.Contracts.V1.Orders.InProgressOrders.IInProgressOrderBase}.","type":"string","readOnly":true},"orderType":{"format":"int32","description":"Gets the type of the {Vista.OmniChannel.Contracts.V1.Orders.InProgressOrders.IInProgressOrderBase}. ['0: Standard','1: GiftShop','2: Subscription']","type":"integer","readOnly":true},"status":{"format":"int32","description":"Gets the status. ['0: Pending','1: Completed','2: Failed']","type":"integer","readOnly":true},"transactionNumber":{"format":"int32","description":"Gets the number generated by the {Vista.OmniChannel.Contracts.V1.Browsing.MasterData.Sites.ISite} that can be used to identify and collect the transaction.","type":"integer","readOnly":true}}},"OrderCustomer&#8203;&#8203;":{"required":["email","preferences"],"type":"object","properties":{"name":{"$ref":"#/definitions/IPersonName&#8203;&#8203;"},"email":{"maxLength":255,"minLength":0,"type":"string"},"phoneNumber":{"maxLength":25,"minLength":0,"type":"string"},"preferences":{"$ref":"#/definitions/IOrderCustomerPreferences&#8203;&#8203;"}}},"IOrderCustomerPreferences&#8203;&#8203;":{"description":"Represents the preferences of an {Vista.OmniChannel.Contracts.V1.Orders.Customers.IOrderCustomer}.","type":"object","properties":{"languageTag":{"description":"Gets the IETF (RFC 4646) language tag.","type":"string","readOnly":true}}},"IOrderCustomer&#8203;&#8203;":{"description":"Represents the details of a customer set against an {Vista.OmniChannel.Contracts.V1.Orders.IOrderBase}.","required":["email","preferences"],"type":"object","properties":{"name":{"$ref":"#/definitions/IPersonName&#8203;&#8203;","description":"Gets the name, if known.","readOnly":true},"email":{"description":"Gets the email address.","type":"string","readOnly":true},"phoneNumber":{"description":"Gets the phone number, if known.","type":"string","readOnly":true},"preferences":{"$ref":"#/definitions/IOrderCustomerPreferences&#8203;&#8203;","description":"Gets the preferences.","readOnly":true}}},"OrderItemsRequest&#8203;&#8203;":{"required":["items"],"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/definitions/IOrderItemRequestBase&#8203;&#8203;"}}}},"IOrderItemRequestBase&#8203;&#8203;":{"description":"Represents the base properties of a requested {Vista.OmniChannel.Contracts.V1.Orders.Items.IOrderItemLineBase}.","required":["itemId","type"],"type":"object","properties":{"id":{"description":"Gets the identifier that can be used to uniquely identify the item within the {Vista.OmniChannel.Contracts.V1.Orders.IOrderBase}.","type":"string","readOnly":true},"rewardId":{"format":"int32","description":"Gets the unique identifier of the {Vista.OmniChannel.Contracts.V1.Loyalty.MasterData.Rewards.IReward} used, if applicable.","type":"integer","readOnly":true},"discountId":{"description":"Gets the unique identifier of the {Vista.OmniChannel.Contracts.V1.Sales.MasterData.Discounts.IDiscount} used, if applicable.","type":"string","readOnly":true},"itemId":{"description":"Gets the unique identifier of the {Vista.OmniChannel.Contracts.V1.Sales.MasterData.Items.IItemBase}.","type":"string","readOnly":true},"type":{"format":"int32","description":"Gets the item type. ['0: Normal','1: ParentSales','2: Package','3: Recipe']","type":"integer","readOnly":true},"parentSalesItemId":{"description":"Gets the unique identifier of the {Vista.OmniChannel.Contracts.V1.Sales.MasterData.Items.ParentSales.IParentSalesItem} this item is an option for.","type":"string","readOnly":true}}},"IInProgressOrderDetails&#x3C;IInProgressOrderBase&#8203;&#8203;&#x3E;&#8203;&#8203;":{"description":"Represents an {Vista.OmniChannel.Contracts.V1.Orders.InProgressOrders.IInProgressOrderBase} entity, and its related data.","required":["order","relatedData"],"type":"object","properties":{"order":{"$ref":"#/definitions/IInProgressOrderBase&#8203;&#8203;","description":"Gets the {Vista.OmniChannel.Contracts.V1.Orders.InProgressOrders.IInProgressOrderBase} entity.","readOnly":true},"relatedData":{"$ref":"#/definitions/IOrderRelatedData&#8203;&#8203;","description":"Gets the related data for the {Vista.OmniChannel.Contracts.V1.Orders.InProgressOrders.IInProgressOrderBase} entity.","readOnly":true}}},"IInProgressOrderBase&#8203;&#8203;":{"description":"Represents the base properties of an {Vista.OmniChannel.Contracts.V1.Orders.IOrderBase} in an {Vista.OmniChannel.Contracts.V1.Orders.OrderStatus.InProgress} state.","required":["hasCustomer"],"type":"object","properties":{"expiresAt":{"format":"date-time","description":"Gets the date and time that the order expires.","type":"string","readOnly":true},"hasCustomer":{"description":"Gets a value indicating whether the {Vista.OmniChannel.Contracts.V1.Orders.Customers.IOrderCustomer} has been set.","type":"boolean","readOnly":true}}},"OrderEmbeddedPaymentCreate&#8203;&#8203;":{"required":["webPaymentMethodId"],"type":"object","properties":{"webPaymentMethodId":{"format":"int32","type":"integer"},"redirectReturnUrl":{"type":"string"},"languageTag":{"type":"string"}}},"ICreatedOrderEmbeddedPayment&#8203;&#8203;":{"description":"Represents an {Vista.OmniChannel.Contracts.V1.Orders.Payments.Embedded.IOrderEmbeddedPayment} that has just been created,\r\nand the {Vista.OmniChannel.Contracts.V1.Orders.Payments.Embedded.IOrderEmbeddedPaymentClientData} required to initialise the UI.","required":["embeddedPayment","clientData"],"type":"object","properties":{"embeddedPayment":{"$ref":"#/definitions/IOrderEmbeddedPayment&#8203;&#8203;","description":"Gets the {Vista.OmniChannel.Contracts.V1.Orders.Payments.Embedded.IOrderEmbeddedPayment} entity.","readOnly":true},"clientData":{"$ref":"#/definitions/IOrderEmbeddedPaymentClientData&#8203;&#8203;","description":"Gets the {Vista.OmniChannel.Contracts.V1.Orders.Payments.Embedded.IOrderEmbeddedPaymentClientData} entity.","readOnly":true}}},"IOrderEmbeddedPayment&#8203;&#8203;":{"description":"Represents an embedded payment that has been added to an {Vista.OmniChannel.Contracts.V1.Orders.IOrderBase}.","required":["id","type","value","status"],"type":"object","properties":{"id":{"description":"Gets the identifier that can be used to uniquely identify the payment within the {Vista.OmniChannel.Contracts.V1.Orders.IOrderBase}.","type":"string","readOnly":true},"type":{"format":"int32","description":"Gets the type. ['0: CinemaProcessed','1: Embedded','2: GiftCard','3: Redirect','4: MemberBalance']","type":"integer","readOnly":true},"value":{"format":"decimal","description":"Gets the monetary value.","type":"number","readOnly":true},"status":{"format":"int32","description":"Gets the status. ['0: NotStarted','1: Pending','2: Declined','3: Completed']","type":"integer","readOnly":true}}},"IOrderEmbeddedPaymentClientData&#8203;&#8203;":{"description":"Represents the details required to initialise the embedded payment UI to complete a {Vista.OmniChannel.Contracts.V1.Orders.Payments.Embedded.ICreatedOrderEmbeddedPayment}.","required":["connectorParametersJson","completePaymentUrl","sdkScriptUrls","connectorScriptUrls","connectorFunctionName","isPaymentButtonIncluded"],"type":"object","properties":{"connectorParametersJson":{"description":"Gets the JSON blob of parameters required by the connector.","type":"string","readOnly":true},"completePaymentUrl":{"description":"Gets the URL that needs to be called after the payment has been accepted.","type":"string","readOnly":true},"sdkScriptUrls":{"description":"Gets the list of SDK script URLs that need to be loaded.","type":"array","items":{"type":"string"},"readOnly":true},"connectorScriptUrls":{"description":"Gets the list of connector script URLs that need to be loaded.","type":"array","items":{"type":"string"},"readOnly":true},"connectorFunctionName":{"description":"Gets the name of the connector function that needs to be called.","type":"string","readOnly":true},"isPaymentButtonIncluded":{"description":"Gets a value indicating whether or not the payment connector UI includes a payment button.","type":"boolean","readOnly":true}}},"OrderGiftCardPaymentCreate&#8203;&#8203;":{"required":["cardNumber"],"type":"object","properties":{"cardNumber":{"type":"string"},"pin":{"type":"string"}}},"IOrderGiftCardPayment&#8203;&#8203;":{"description":"Represents a gift card payment that has been added to an {Vista.OmniChannel.Contracts.V1.Orders.IOrderBase}.","required":["maskedCardNumber","id","type","value","status"],"type":"object","properties":{"maskedCardNumber":{"description":"Gets a masked representation of the card number.","type":"string","readOnly":true},"id":{"description":"Gets the identifier that can be used to uniquely identify the payment within the {Vista.OmniChannel.Contracts.V1.Orders.IOrderBase}.","type":"string","readOnly":true},"type":{"format":"int32","description":"Gets the type. ['0: CinemaProcessed','1: Embedded','2: GiftCard','3: Redirect','4: MemberBalance']","type":"integer","readOnly":true},"value":{"format":"decimal","description":"Gets the monetary value.","type":"number","readOnly":true},"status":{"format":"int32","description":"Gets the status. ['0: NotStarted','1: Pending','2: Declined','3: Completed']","type":"integer","readOnly":true}}},"RateLimitExceededError&#8203;&#8203;":{"required":["title"],"type":"object","properties":{"blockedUntil":{"format":"date-time","type":"string"},"correlationId":{"type":"string"},"originalRequestUrl":{"type":"string"},"type":{"type":"string"},"status":{"format":"int32","type":"integer"},"title":{"type":"string"},"detail":{"type":"string"},"instance":{"type":"string"}}},"OrderRedirectPaymentCreate&#8203;&#8203;":{"required":["webPaymentMethodId","redirectReturnUrl"],"type":"object","properties":{"webPaymentMethodId":{"format":"int32","type":"integer"},"redirectReturnUrl":{"type":"string"}}},"ICreatedOrderRedirectPayment&#8203;&#8203;":{"description":"Represents an {Vista.OmniChannel.Contracts.V1.Orders.Payments.Redirect.IOrderRedirectPayment} that has just been created, and the {Vista.OmniChannel.Contracts.V1.Orders.Payments.Redirect.ICreatedOrderRedirectPayment.RedirectUrl} to the payment page.","required":["redirectPayment","redirectUrl"],"type":"object","properties":{"redirectPayment":{"$ref":"#/definitions/IOrderRedirectPayment&#8203;&#8203;","description":"Gets the {Vista.OmniChannel.Contracts.V1.Orders.Payments.Redirect.IOrderRedirectPayment} entity.","readOnly":true},"redirectUrl":{"description":"Gets the URL of the payment page.","type":"string","readOnly":true}}},"IOrderRedirectPayment&#8203;&#8203;":{"description":"Represents a redirect payment that has been added to an {Vista.OmniChannel.Contracts.V1.Orders.IOrderBase}.","required":["id","type","value","status"],"type":"object","properties":{"id":{"description":"Gets the identifier that can be used to uniquely identify the payment within the {Vista.OmniChannel.Contracts.V1.Orders.IOrderBase}.","type":"string","readOnly":true},"type":{"format":"int32","description":"Gets the type. ['0: CinemaProcessed','1: Embedded','2: GiftCard','3: Redirect','4: MemberBalance']","type":"integer","readOnly":true},"value":{"format":"decimal","description":"Gets the monetary value.","type":"number","readOnly":true},"status":{"format":"int32","description":"Gets the status. ['0: NotStarted','1: Pending','2: Declined','3: Completed']","type":"integer","readOnly":true}}},"IOrderMaximumMemberBalancePaymentDetails&#8203;&#8203;":{"description":"Represents an {Vista.OmniChannel.Contracts.V1.Orders.Payments.MemberBalance.Maximum.IOrderMaximumMemberBalancePayment} entity, and its related data.","required":["payment","relatedData"],"type":"object","properties":{"payment":{"$ref":"#/definitions/IOrderMaximumMemberBalancePayment&#8203;&#8203;","description":"Gets the {Vista.OmniChannel.Contracts.V1.Orders.Payments.MemberBalance.Maximum.IOrderMaximumMemberBalancePayment} entity.","readOnly":true},"relatedData":{"$ref":"#/definitions/IOrderMaximumMemberBalancePaymentRelatedData&#8203;&#8203;","description":"Gets the related data for the {Vista.OmniChannel.Contracts.V1.Orders.Payments.MemberBalance.Maximum.IOrderMaximumMemberBalancePayment} entity.","readOnly":true}}},"IOrderMaximumMemberBalancePayment&#8203;&#8203;":{"description":"Represents the maximum {Vista.OmniChannel.Contracts.V1.Orders.Payments.MemberBalance.IOrderMemberBalancePayment} value for an {Vista.OmniChannel.Contracts.V1.Orders.InProgressOrders.IInProgressOrderBase}.","required":["balanceTypeId","maximumValue","maximumUnits","availableUnits"],"type":"object","properties":{"balanceTypeId":{"format":"int32","description":"Gets the unique identifier of the {Vista.OmniChannel.Contracts.V1.Loyalty.MasterData.BalanceTypes.IBalanceType}.","type":"integer","readOnly":true},"maximumValue":{"format":"decimal","description":"Gets the maximum eligible monetary value.","type":"number","readOnly":true},"maximumUnits":{"format":"decimal","description":"Gets the maximum eligible value in {Vista.OmniChannel.Contracts.V1.Loyalty.MasterData.BalanceTypes.IBalanceType} units.","type":"number","readOnly":true},"availableUnits":{"format":"decimal","description":"Gets the total available {Vista.OmniChannel.Contracts.V1.Loyalty.Members.Balances.IMemberBalance} units, including those not eligible to be used as payment for the {Vista.OmniChannel.Contracts.V1.Orders.InProgressOrders.IInProgressOrderBase}.","type":"number","readOnly":true}}},"IOrderMaximumMemberBalancePaymentRelatedData&#8203;&#8203;":{"description":"Related data for an {Vista.OmniChannel.Contracts.V1.Orders.Payments.MemberBalance.Maximum.IOrderMaximumMemberBalancePayment} entity.","required":["balanceType"],"type":"object","properties":{"balanceType":{"$ref":"#/definitions/IBalanceType&#8203;&#8203;","description":"Gets the related {Vista.OmniChannel.Contracts.V1.Loyalty.MasterData.BalanceTypes.IBalanceType} entity.","readOnly":true}}},"OrderMemberBalancePaymentUpdate&#8203;&#8203;":{"type":"object","properties":{"value":{"format":"double","type":"number"}}},"IOrderMemberBalancePayment&#8203;&#8203;":{"description":"Represents a {Vista.OmniChannel.Contracts.V1.Loyalty.Members.Balances.IMemberBalance} payment that has been added to an {Vista.OmniChannel.Contracts.V1.Orders.IOrderBase}.","required":["balanceTypeId","units","id","type","value","status"],"type":"object","properties":{"balanceTypeId":{"format":"int32","description":"Gets the unique identifier of the {Vista.OmniChannel.Contracts.V1.Loyalty.MasterData.BalanceTypes.IBalanceType}.","type":"integer","readOnly":true},"units":{"format":"decimal","description":"Gets the value in {Vista.OmniChannel.Contracts.V1.Loyalty.MasterData.BalanceTypes.IBalanceType} units.","type":"number","readOnly":true},"id":{"description":"Gets the identifier that can be used to uniquely identify the payment within the {Vista.OmniChannel.Contracts.V1.Orders.IOrderBase}.","type":"string","readOnly":true},"type":{"format":"int32","description":"Gets the type. ['0: CinemaProcessed','1: Embedded','2: GiftCard','3: Redirect','4: MemberBalance']","type":"integer","readOnly":true},"value":{"format":"decimal","description":"Gets the monetary value.","type":"number","readOnly":true},"status":{"format":"int32","description":"Gets the status. ['0: NotStarted','1: Pending','2: Declined','3: Completed']","type":"integer","readOnly":true}}},"StandardOrderAsBookingCreate&#8203;&#8203;":{"required":["siteId","bookingMode"],"type":"object","properties":{"siteId":{"type":"string"},"bookingMode":{"format":"int32","description":"['0: Paid','1: Unpaid','2: UnpaidConfirmed']","type":"integer"}}},"IInProgressOrderDetails&#x3C;IInProgressStandardOrder&#8203;&#8203;&#x3E;&#8203;&#8203;":{"description":"Represents an {Vista.OmniChannel.Contracts.V1.Orders.InProgressOrders.IInProgressOrderBase} entity, and its related data.","required":["order","relatedData"],"type":"object","properties":{"order":{"$ref":"#/definitions/IInProgressStandardOrder&#8203;&#8203;","description":"Gets the {Vista.OmniChannel.Contracts.V1.Orders.InProgressOrders.IInProgressOrderBase} entity.","readOnly":true},"relatedData":{"$ref":"#/definitions/IOrderRelatedData&#8203;&#8203;","description":"Gets the related data for the {Vista.OmniChannel.Contracts.V1.Orders.InProgressOrders.IInProgressOrderBase} entity.","readOnly":true}}},"IInProgressStandardOrder&#8203;&#8203;":{"description":"Represents a {Vista.OmniChannel.Contracts.V1.Orders.IStandardOrder} in an {Vista.OmniChannel.Contracts.V1.Orders.OrderStatus.InProgress} state.","required":["booking","showtimes","items","ticketRedemptionCards","siteId","type","status","totalPrice","amountSaved","vouchers","deals","payments","hasCustomer"],"type":"object","properties":{"booking":{"$ref":"#/definitions/IInProgressOrderBooking&#8203;&#8203;","description":"Gets the booking details.","readOnly":true},"showtimes":{"description":"Gets the list of {Vista.OmniChannel.Contracts.V1.Orders.Showtimes.IOrderShowtime} entities.","type":"array","items":{"$ref":"#/definitions/IOrderShowtime&#8203;&#8203;"},"readOnly":true},"items":{"description":"Gets the list of {Vista.OmniChannel.Contracts.V1.Orders.Items.IOrderItemLineBase} entities.","type":"array","items":{"$ref":"#/definitions/IOrderItemLineBase&#8203;&#8203;"},"readOnly":true},"ticketRedemptionCards":{"description":"Gets the list of {Vista.OmniChannel.Contracts.V1.Orders.TicketRedemptionCards.IOrderTicketRedemptionCard} entities.","type":"array","items":{"$ref":"#/definitions/IOrderTicketRedemptionCard&#8203;&#8203;"},"readOnly":true},"siteId":{"description":"Gets the unique identifier of the {Vista.OmniChannel.Contracts.V1.Browsing.MasterData.Sites.ISite}.","type":"string","readOnly":true},"tip":{"$ref":"#/definitions/IOrderTip&#8203;&#8203;","description":"Gets the tip.","readOnly":true},"id":{"description":"Gets the unique identifier.","type":"string","readOnly":true},"type":{"format":"int32","description":"Gets the type. ['0: Standard','1: GiftShop','2: Subscription']","type":"integer","readOnly":true},"status":{"format":"int32","description":"Gets the status. ['0: InProgress','1: Completed']","type":"integer","readOnly":true},"totalPrice":{"$ref":"#/definitions/IMonetaryValue&#8203;&#8203;","description":"Gets the total price to be displayed to the customer.","readOnly":true},"amountSaved":{"$ref":"#/definitions/IMonetaryValue&#8203;&#8203;","description":"Gets the monetary amount saved via discounted prices.","readOnly":true},"vouchers":{"description":"Gets the list of {Vista.OmniChannel.Contracts.V1.Orders.Vouchers.IOrderVoucher} entities.","type":"array","items":{"$ref":"#/definitions/IOrderVoucher&#8203;&#8203;"},"readOnly":true},"deals":{"description":"Gets the list of {Vista.OmniChannel.Contracts.V1.Orders.Deals.IOrderDeal} entities.","type":"array","items":{"$ref":"#/definitions/IOrderDeal&#8203;&#8203;"},"readOnly":true},"payments":{"description":"Gets the list of {Vista.OmniChannel.Contracts.V1.Orders.Payments.IOrderPaymentBase} entities.","type":"array","items":{"$ref":"#/definitions/IOrderPaymentBase&#8203;&#8203;"},"readOnly":true},"expiresAt":{"format":"date-time","description":"Gets the date and time that the order expires.","type":"string","readOnly":true},"hasCustomer":{"description":"Gets a value indicating whether the {Vista.OmniChannel.Contracts.V1.Orders.Customers.IOrderCustomer} has been set.","type":"boolean","readOnly":true}}},"IInProgressOrderBooking&#8203;&#8203;":{"description":"Represents the booking details of a {Vista.OmniChannel.Contracts.V1.Orders.InProgressOrders.IInProgressStandardOrder}.","required":["mode","totalBookingFee"],"type":"object","properties":{"mode":{"format":"int32","description":"Gets the order booking mode. ['0: Paid','1: Unpaid','2: UnpaidConfirmed']","type":"integer","readOnly":true},"totalBookingFee":{"$ref":"#/definitions/IMonetaryValue&#8203;&#8203;","description":"Gets the total booking fee amount the customer has currently paid.","readOnly":true}}},"IInProgressOrderDetails&#x3C;IInProgressSubscriptionOrder&#8203;&#8203;&#x3E;&#8203;&#8203;":{"description":"Represents an {Vista.OmniChannel.Contracts.V1.Orders.InProgressOrders.IInProgressOrderBase} entity, and its related data.","required":["order","relatedData"],"type":"object","properties":{"order":{"$ref":"#/definitions/IInProgressSubscriptionOrder&#8203;&#8203;","description":"Gets the {Vista.OmniChannel.Contracts.V1.Orders.InProgressOrders.IInProgressOrderBase} entity.","readOnly":true},"relatedData":{"$ref":"#/definitions/IOrderRelatedData&#8203;&#8203;","description":"Gets the related data for the {Vista.OmniChannel.Contracts.V1.Orders.InProgressOrders.IInProgressOrderBase} entity.","readOnly":true}}},"IInProgressSubscriptionOrder&#8203;&#8203;":{"description":"Represents a {Vista.OmniChannel.Contracts.V1.Orders.ISubscriptionOrder} in an {Vista.OmniChannel.Contracts.V1.Orders.OrderStatus.InProgress} state.","required":["type","status","totalPrice","amountSaved","vouchers","deals","payments","hasCustomer"],"type":"object","properties":{"subscription":{"$ref":"#/definitions/IOrderSubscription&#8203;&#8203;","description":"Gets the subscription.","readOnly":true},"id":{"description":"Gets the unique identifier.","type":"string","readOnly":true},"type":{"format":"int32","description":"Gets the type. ['0: Standard','1: GiftShop','2: Subscription']","type":"integer","readOnly":true},"status":{"format":"int32","description":"Gets the status. ['0: InProgress','1: Completed']","type":"integer","readOnly":true},"totalPrice":{"$ref":"#/definitions/IMonetaryValue&#8203;&#8203;","description":"Gets the total price to be displayed to the customer.","readOnly":true},"amountSaved":{"$ref":"#/definitions/IMonetaryValue&#8203;&#8203;","description":"Gets the monetary amount saved via discounted prices.","readOnly":true},"vouchers":{"description":"Gets the list of {Vista.OmniChannel.Contracts.V1.Orders.Vouchers.IOrderVoucher} entities.","type":"array","items":{"$ref":"#/definitions/IOrderVoucher&#8203;&#8203;"},"readOnly":true},"deals":{"description":"Gets the list of {Vista.OmniChannel.Contracts.V1.Orders.Deals.IOrderDeal} entities.","type":"array","items":{"$ref":"#/definitions/IOrderDeal&#8203;&#8203;"},"readOnly":true},"payments":{"description":"Gets the list of {Vista.OmniChannel.Contracts.V1.Orders.Payments.IOrderPaymentBase} entities.","type":"array","items":{"$ref":"#/definitions/IOrderPaymentBase&#8203;&#8203;"},"readOnly":true},"expiresAt":{"format":"date-time","description":"Gets the date and time that the order expires.","type":"string","readOnly":true},"hasCustomer":{"description":"Gets a value indicating whether the {Vista.OmniChannel.Contracts.V1.Orders.Customers.IOrderCustomer} has been set.","type":"boolean","readOnly":true}}},"IOrderSubscription&#8203;&#8203;":{"description":"Represents the selected {Vista.OmniChannel.Contracts.V1.Sales.MasterData.SubscriptionBillingOptions.ISubscriptionBillingOption} within a {Vista.OmniChannel.Contracts.V1.Orders.ISubscriptionOrder}.","required":["subscriptionId","subscriptionBillingOptionId","price"],"type":"object","properties":{"subscriptionId":{"format":"int32","description":"Gets the unique identifier of the {Vista.OmniChannel.Contracts.V1.Loyalty.MasterData.Subscriptions.ISubscription}.","type":"integer","readOnly":true},"subscriptionBillingOptionId":{"description":"Gets the unique identifier of the {Vista.OmniChannel.Contracts.V1.Sales.MasterData.SubscriptionBillingOptions.ISubscriptionBillingOption}.","type":"string","readOnly":true},"price":{"$ref":"#/definitions/IMonetaryValue&#8203;&#8203;","description":"Gets the price to be displayed to the customer.","readOnly":true},"discountId":{"description":"Gets the unique identifier of the {Vista.OmniChannel.Contracts.V1.Sales.MasterData.Discounts.IDiscount} used, if applicable.","type":"string","readOnly":true},"voucherId":{"description":"Gets the unique identifier of the {Vista.OmniChannel.Contracts.V1.Orders.Vouchers.IOrderVoucher} used, if applicable.","type":"string","readOnly":true}}},"IInProgressOrderDetails&#x3C;IInProgressGiftShopOrder&#8203;&#8203;&#x3E;&#8203;&#8203;":{"description":"Represents an {Vista.OmniChannel.Contracts.V1.Orders.InProgressOrders.IInProgressOrderBase} entity, and its related data.","required":["order","relatedData"],"type":"object","properties":{"order":{"$ref":"#/definitions/IInProgressGiftShopOrder&#8203;&#8203;","description":"Gets the {Vista.OmniChannel.Contracts.V1.Orders.InProgressOrders.IInProgressOrderBase} entity.","readOnly":true},"relatedData":{"$ref":"#/definitions/IOrderRelatedData&#8203;&#8203;","description":"Gets the related data for the {Vista.OmniChannel.Contracts.V1.Orders.InProgressOrders.IInProgressOrderBase} entity.","readOnly":true}}},"IInProgressGiftShopOrder&#8203;&#8203;":{"description":"Represents a {Vista.OmniChannel.Contracts.V1.Orders.IGiftShopOrder} in an {Vista.OmniChannel.Contracts.V1.Orders.OrderStatus.InProgress} state.","required":["items","type","status","totalPrice","amountSaved","vouchers","deals","payments","hasCustomer"],"type":"object","properties":{"items":{"description":"Gets the list of {Vista.OmniChannel.Contracts.V1.Orders.Items.IOrderItemLineBase} entities.","type":"array","items":{"$ref":"#/definitions/IOrderItemLineBase&#8203;&#8203;"},"readOnly":true},"id":{"description":"Gets the unique identifier.","type":"string","readOnly":true},"type":{"format":"int32","description":"Gets the type. ['0: Standard','1: GiftShop','2: Subscription']","type":"integer","readOnly":true},"status":{"format":"int32","description":"Gets the status. ['0: InProgress','1: Completed']","type":"integer","readOnly":true},"totalPrice":{"$ref":"#/definitions/IMonetaryValue&#8203;&#8203;","description":"Gets the total price to be displayed to the customer.","readOnly":true},"amountSaved":{"$ref":"#/definitions/IMonetaryValue&#8203;&#8203;","description":"Gets the monetary amount saved via discounted prices.","readOnly":true},"vouchers":{"description":"Gets the list of {Vista.OmniChannel.Contracts.V1.Orders.Vouchers.IOrderVoucher} entities.","type":"array","items":{"$ref":"#/definitions/IOrderVoucher&#8203;&#8203;"},"readOnly":true},"deals":{"description":"Gets the list of {Vista.OmniChannel.Contracts.V1.Orders.Deals.IOrderDeal} entities.","type":"array","items":{"$ref":"#/definitions/IOrderDeal&#8203;&#8203;"},"readOnly":true},"payments":{"description":"Gets the list of {Vista.OmniChannel.Contracts.V1.Orders.Payments.IOrderPaymentBase} entities.","type":"array","items":{"$ref":"#/definitions/IOrderPaymentBase&#8203;&#8203;"},"readOnly":true},"expiresAt":{"format":"date-time","description":"Gets the date and time that the order expires.","type":"string","readOnly":true},"hasCustomer":{"description":"Gets a value indicating whether the {Vista.OmniChannel.Contracts.V1.Orders.Customers.IOrderCustomer} has been set.","type":"boolean","readOnly":true}}},"OrderShowtimeRequest&#8203;&#8203;":{"type":"object","properties":{"tickets":{"type":"array","items":{"$ref":"#/definitions/IOrderTicketRequest&#8203;&#8203;"}},"seats":{"type":"array","items":{"type":"string"}}}},"IOrderTicketRequest&#8203;&#8203;":{"description":"Represents the details of a requested {Vista.OmniChannel.Contracts.V1.Orders.Tickets.IOrderTicketLineBase} for an {Vista.OmniChannel.Contracts.V1.Orders.Showtimes.IOrderShowtime}.","required":["ticketTypeId"],"type":"object","properties":{"id":{"description":"Gets the identifier that can be used to uniquely identify the ticket within the {Vista.OmniChannel.Contracts.V1.Orders.IOrderBase}.","type":"string","readOnly":true},"ticketTypeId":{"description":"Gets the unique identifier of the {Vista.OmniChannel.Contracts.V1.Sales.MasterData.TicketTypes.ITicketTypeBase}.","type":"string","readOnly":true},"rewardId":{"format":"int32","description":"Gets the unique identifier of the {Vista.OmniChannel.Contracts.V1.Loyalty.MasterData.Rewards.IReward} used, if applicable.","type":"integer","readOnly":true},"ticketRedemptionCardId":{"format":"uuid","description":"Gets the unique identifier of the {Vista.OmniChannel.Contracts.V1.Orders.TicketRedemptionCards.IOrderTicketRedemptionCard} used, if applicable.","type":"string","readOnly":true},"voucherId":{"description":"Gets the unique identifier of the {Vista.OmniChannel.Contracts.V1.Orders.Vouchers.IOrderVoucher} used, if applicable.","type":"string","readOnly":true}}},"OrderSubscriptionRequest&#8203;&#8203;":{"required":["subscriptionBillingOptionId"],"type":"object","properties":{"subscriptionBillingOptionId":{"type":"string"},"discountId":{"type":"string"},"voucherId":{"type":"string"}}},"OrderTicketRedemptionCardRequestBase&#8203;&#8203;":{"required":["showtimeId","type"],"type":"object","properties":{"showtimeId":{"type":"string"},"type":{"format":"int32","description":"['0: ThirdPartyMemberCard','1: MemberTicketRedemptionCard']","type":"integer","readOnly":true}}},"IOrderTicketRedemptionCardDetails&#8203;&#8203;":{"description":"Represents the details of an {Vista.OmniChannel.Contracts.V1.Orders.TicketRedemptionCards.IOrderTicketRedemptionCard} that has been added to an {Vista.OmniChannel.Contracts.V1.Orders.InProgressOrders.IInProgressStandardOrder},\r\nand its {Vista.OmniChannel.Contracts.V1.Orders.TicketRedemptionCards.IOrderTicketRedemptionCardDetails.RedemptionLimit}.","required":["ticketRedemptionCard","redemptionLimit"],"type":"object","properties":{"ticketRedemptionCard":{"$ref":"#/definitions/IOrderTicketRedemptionCard&#8203;&#8203;","description":"Gets the {Vista.OmniChannel.Contracts.V1.Orders.TicketRedemptionCards.IOrderTicketRedemptionCard} entity.","readOnly":true},"redemptionLimit":{"$ref":"#/definitions/IQuantityLimit&#8203;&#8203;","description":"Gets the maximum number of times that the {Vista.OmniChannel.Contracts.V1.Orders.TicketRedemptionCards.IOrderTicketRedemptionCardDetails.TicketRedemptionCard} can currently be redeemed for the particular {Vista.OmniChannel.Contracts.V1.Browsing.MasterData.Showtimes.IShowtime}.","readOnly":true}}},"IQuantityLimit&#8203;&#8203;":{"description":"Represents a limited or unlimited quantity.","required":["isUnlimited","minimum"],"type":"object","properties":{"isUnlimited":{"description":"Gets a value indicating whether the quantity is unlimited.","type":"boolean","readOnly":true},"maximum":{"format":"int32","description":"Gets the maximum quantity allowed.","type":"integer","readOnly":true},"minimum":{"format":"int32","description":"Gets the minimum quantity allowed (0 by default).","type":"integer","readOnly":true}}},"OrderVoucherRequestBase&#8203;&#8203;":{"required":["type","credentials"],"type":"object","properties":{"type":{"format":"int32","description":"['0: Ticket','1: Subscription','2: Deal']","type":"integer","readOnly":true},"credentials":{"$ref":"#/definitions/IVoucherCredentials&#8203;&#8203;"}}},"IVoucherCredentials&#8203;&#8203;":{"description":"Represents the details required to identify and validate a voucher.","required":["barcode"],"type":"object","properties":{"barcode":{"description":"Gets the barcode.","type":"string","readOnly":true},"pin":{"description":"Gets the PIN.","type":"string","readOnly":true}}},"IOrderVoucherDetails&#8203;&#8203;":{"description":"Represents the details of an {Vista.OmniChannel.Contracts.V1.Orders.Vouchers.IOrderVoucher} entity that has been added to an {Vista.OmniChannel.Contracts.V1.Orders.IOrderBase},\r\nand its {Vista.OmniChannel.Contracts.V1.Orders.Vouchers.IOrderVoucherDetails.AvailableRedemptions}.","required":["voucher","availableRedemptions"],"type":"object","properties":{"voucher":{"$ref":"#/definitions/IOrderVoucher&#8203;&#8203;","description":"Gets the {Vista.OmniChannel.Contracts.V1.Orders.Vouchers.IOrderVoucher} entity.","readOnly":true},"availableRedemptions":{"format":"int32","description":"Gets the maximum number of times that the {Vista.OmniChannel.Contracts.V1.Orders.Vouchers.IOrderVoucherDetails.Voucher} can be redeemed.","type":"integer","readOnly":true}}},"IShowtimeSeatAvailability&#8203;&#8203;":{"description":"Represents a list of {Vista.OmniChannel.Contracts.V1.Seating.Availability.ISeatAvailability} entities for a particular {Vista.OmniChannel.Contracts.V1.Browsing.MasterData.Showtimes.IShowtime}.","required":["seatAvailabilities","isSoldOut"],"type":"object","properties":{"seatAvailabilities":{"description":"Gets the list of {Vista.OmniChannel.Contracts.V1.Seating.Availability.ISeatAvailability} entities.","type":"array","items":{"$ref":"#/definitions/ISeatAvailability&#8203;&#8203;"},"readOnly":true},"isSoldOut":{"description":"Gets a value indicating whether the {Vista.OmniChannel.Contracts.V1.Browsing.MasterData.Showtimes.IShowtime} is sold out.","type":"boolean","readOnly":true}}},"ISeatAvailability&#8203;&#8203;":{"description":"Represents the current availability of a {Vista.OmniChannel.Contracts.V1.Seating.MasterData.ISeat}.","required":["seatId","status"],"type":"object","properties":{"seatId":{"description":"Gets the unique identifier of the {Vista.OmniChannel.Contracts.V1.Seating.MasterData.ISeat}.","type":"string","readOnly":true},"status":{"format":"int32","description":"Gets the availability status. ['0: Available','1: Sold','2: Broken','3: House']","type":"integer","readOnly":true}}},"OrderTipRequest&#8203;&#8203;":{"type":"object","properties":{"amount":{"format":"decimal","type":"number"}}}},"parameters":{},"responses":{},"securityDefinitions":{},"security":[],"tags":[]}